This repository contains a template to be used as a starting point for a new NiPrep processing pipeline.
A NiPreps project named {{project_name}}
(e.g. MyPrep
) will typically have the following structure:
{{project_slug}}/
βββ .github/
β βββ ...
βββ .maint/
β βββ ...
βββ docs/
β βββ ...
βββ tests/
β βββ ...
βββ {{project_slug}}/
β βββ cli/
β β βββ __init__.py
β β βββ parser.py
β β βββ run.py
β β βββ version.py
β β βββ workflow.py
β βββ data/
β β βββ __init__.py
β β βββ ...
β βββ interfaces/
β β βββ __init__.py
β β βββ ...
β βββ utils/
β β βββ __init__.py
β β βββ bids.py
β βββ workflows/
β β βββ base.py
β βββ __init__.py
β βββ __main__.py
β βββ config.py
β βββ conftest.py
βββ ...
βββ Dockerfile
βββ ...
βββ pyproject.toml
βββ README.md
βββ tox.ini
where {{project_slug}}
corresponds to the all lowercase name of the project to be used as the root directory to host
the relevant processing source code (e.g. myprep
).