Installation
Code installation and dataset setup
The Nipoppy workflow comprises a Nipoppy codebase that operates on a Nipoppy dataset with a specific directory structure (initialized with a tree.py
script).
Nipoppy code+env installation
- Change directory to where you want to clone this repo, e.g.:
cd /home/<user>/projects/<my_project>/code/
- Create a new venv:
python3 -m venv nipoppy_env
- Alternatively (if using Anaconda/Miniconda), create a
conda
environment:conda create --name nipoppy_env python=3.9
- Alternatively (if using Anaconda/Miniconda), create a
- Activate your env:
source nipoppy_env/bin/activate
- If using Anaconda/Miniconda:
conda activate nipoppy_env
- If using Anaconda/Miniconda:
- Clone this repo:
git clone https://github.com/neurodatascience/nipoppy.git
- Change directory to
nipoppy
- Install python dependencies:
pip install -e .
Nipoppy dataset directory setup
Run nipoppy/tree.py
to create the Nipoppy dataset directory tree:
python nipoppy/tree.py --nipoppy_root <DATASET_ROOT>
DATASET_ROOT
: root (starting point) of the Nipoppy structured dataset
Suggestion
We suggest naming DATASET_ROOT directory after a study or a cohort.