Skip to content

Commit e61f6b7

Browse files
committed
DOC: Add a minimal description of a NiPreps project
Add a minimal description of a data processing pipeline project under the `NiPreps` convention.
1 parent ee7f920 commit e61f6b7

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# NiPreps Project Template
2+
3+
## Overview
4+
5+
This repository contains a template to be used as a starting point for a new *NiPrep* processing pipeline.
6+
7+
A *NiPreps* project named `{{project_name}}` (e.g. `MyPrep`) will typically have the following structure:
8+
9+
```
10+
{{project_slug}}/
11+
├── .github/
12+
│ └── ...
13+
├── .maint/
14+
│ └── ...
15+
├── docs/
16+
│ └── ...
17+
├── tests/
18+
│ └── ...
19+
├── {{project_slug}}/
20+
│ ├── cli/
21+
│ │ ├── __init__.py
22+
│ │ ├── parser.py
23+
│ │ ├── run.py
24+
│ │ ├── version.py
25+
│ │ └── workflow.py
26+
│ ├── data/
27+
│ │ ├── __init__.py
28+
│ │ └── ...
29+
│ ├── interfaces/
30+
│ │ ├── __init__.py
31+
│ │ └── ...
32+
│ ├── utils/
33+
│ │ ├── __init__.py
34+
│ │ └── bids.py
35+
│ ├── workflows/
36+
│ │ └── base.py
37+
│ ├── __init__.py
38+
│ ├── __main__.py
39+
│ ├── config.py
40+
│ └── conftest.py
41+
├── ...
42+
├── Dockerfile
43+
├── ...
44+
├── pyproject.toml
45+
├── README.md
46+
└── tox.ini
47+
```
48+
49+
where `{{project_slug}}` corresponds to the all lowercase name of the project to be used as the root directory to host
50+
the relevant processing source code (e.g. `myprep`).

0 commit comments

Comments
 (0)