neurodatascience / nipoppy-enigma

nipoppy: lightweight neuroimaging workflow manager. Pull-Organize-Process-Push-Yay!

nipoppy

A workflow manager for curating MRI and tabular data and standardized processing.

Pull-Organize-Process-Push-Yey!

Note: This is a template branch which is typically customized for a specific dataset

Documentation

nipoppy modules

• nipoppy

Individual containerized pipelines:

• Heudionv
• MRIQC
• fMRIPrep
• TractoFlow
• MAGeT Brain

GH workflow for contributing to template and dataset-specific forks

Organization

• Under the neurodatascience GitHub organization:
  • The nipoppy(*) ("template") repository contains all common code-base: neurodatascience/nipoppy
  • Make a fork for each dataset: neurodatascience/nipoppy-[dataset]
• Under the user GitHub account:
  • Make a fork of nipoppy(*) ("template") repository: <user>/nipoppy
• Local machine
  • Clone all the neurodatascience/nipoppy-[dataset] and the <user>/nipoppy repos.

Basic principles

• nipoppy(*) is the code-base common across all dataset forks
• nipoppy-[dataset] will have additional files but there should not be different versions of the same file (including README.md) between nipoppy(*) and nipoppy-[dataset]
• Branch-protection are set to avoid direct commits to all main branches. Contributions should be done through PRs only
• Updates to nipoppy(*) and nipoppy-[dataset] will follow separate paths requiring different repo-clones on the local machine
• GH-Actions are used to distribute common changes from nipoppy(*) to nipoppy-[dataset]
• Nothing is pushed from neurodatascience/nipoppy-[dataset] to neurodatascience/nipoppy

Contribution steps:

• Changes that apply to all datasets (e.g. bids conversion, pipeline run scripts, tracker scripts):
  • Make a user fork of neurodatascience/nipoppy: [gh-username]/nipoppy
  • Clone [gh-username]/nipoppy locally
  • Push to [gh-username]/nipoppy on GitHub
  • PR from [gh-username]/nipoppy to neurodatascience/nipoppy
  • Any time a PR is merged to neurodatascience/nipoppy:main, the newly added changes (common across dataset) will propagate automatically to all neurodatascience/nipoppy-[dataset] forks through a GitHub Actions workflow
    • In each dataset fork, the main-upstream branch is created/updated automatically to match neurodatascience/nipoppy:main
    • A PR labelled "automerge" is automatically created to incorporate changes from main-upstream to main
    • "Automerge" PRs are approved and merged automatically if there are no merge conflicts
      • If merge conflicts exist, they must be resolved manually. Then the PR needs to be merged, without squashing or rebasing
• Changes that apply to individual datasets (e.g. dicom wrangling, statistical analysis)
  • Clone neurodatascience/nipoppy-[dataset] locally
  • Make a new branch when working on a new feature
    • main is protected on these forks as well - all contributions have to be made through dev branches.
    • IMPORTANT: need to be careful with branch names, they should be unique
  • PR from neurodatascience/nipoppy-[dataset]:[feature_branch] to neurodatascience/nipoppy-[dataset]:main
  • Delete branch when done
• Adding a new dataset
  • Make a new fork of the template repo (neurodatascience/nipoppy) called neurodatascience/nipoppy-[dataset]
  • Update the GitHub Actions workflow file to add the new fork to the job matrix
  • Add dataset-specific files to the fork and begin processing (see the nipoppy documentation for more information)