https://github.com/pyfar/template-publication-workflow
https://github.com/pyfar/template-publication-workflow
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pyfar/template-publication-workflow
- Owner: pyfar
- License: mit
- Created: 2025-10-27T15:55:47.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-11-04T09:40:46.000Z (9 months ago)
- Last Synced: 2025-11-04T11:27:14.501Z (9 months ago)
- Language: Jinja
- Size: 131 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Template: Publication workflow
A simple template intended for data processing workflows alongside scientific publications.
This template can be used with [copier](https://copier.readthedocs.io) to initialize a
new project structure.
Workflows are implemented using [snakemake](https://snakemake.readthedocs.io/en/stable/).
# Getting started
To use this template:
1. Install copier using pip within a virtual environment
```console
pip install copier
```
2. Run the below copier command to create a target directory at `path_to_target_folder`.
Note: copier will overwrite files in the given directory, if it already exists.
```console
copier copy https://github.com/pyfar/template-publication-workflow path_to_target_folder
```
3. Open the *README.md* in the created project directory to get started with your project.
# Contributing
Check out [pyfar.org](https://pyfar-gallery.readthedocs.io/en/latest/contribute/index.html) if you want to become part of pyfar.