Skip to main content

Installation

Currently a published pre-release from PyPI. Need explicit version to select this, i.e.:

python -m pip install nipact==0.0.1a1
nipact --help
nipact --version

To work from a source checkout instead (e.g. for development):

python -m pip install -e .

NIPACT requires Python 3.12 or newer.

Additional Dependencies:

  • workflow run uses Snakemake for execution.
  • GUI uses FastAPI and Uvicorn, but these are not required for the core CLI functionality.

Current available commands summary:

  • --help, --version, init, validate
  • workflow inspection commands: workflow run, trace, and gui
  • Included demos: colors, fmri, and dfc;
    • the fMRI and DFC demos run on tiny generated NumPy inputs.
    • See Scope and Limitations for the commands and demo types that are not part of this release.

After installation, see tutorials to get started:

Also see: CLI usage reference.