Skip to content

DOC: Add a minimal description of a NiPreps project #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC: Add a minimal description of a NiPreps project #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# NiPreps Project Template

## Overview

This repository contains a template to be used as a starting point for a new *NiPrep* processing pipeline.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How should we call a general NiPreps project? I've used processing pipeline, but not totally convinced.


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`).