Skip to main content

Introduction

NIPACT is a proof of concept workflow orchestration tool utilizing snakemake for execution, and includes a set of cli commands for project initialization, validation, workflow inspection, and execution.

In this release, nipact init creates packaged colors, fmri, and dfc demo projects and runtime roots.

The fMRI and DFC demos run on synthetic data as packaged. The documentation shows examples from real data. Future release will include a real-data bootstrap and aligned documentation. The goals of the demos are to demonstrate generic and neuroimaging-shaped syntax and semantics for source bindings, manifests, input/output handling in execution, and provenance auditing. CLI commands such as nipact validate checks project configs and some runtime data without mutating files. Projects utilize a registry.db SQLite database to record necessary workflow abstractions including sources, outputs, dependencies, hashes, etc., to allow for provenance auditing and artifact reuse. See more in the following sections and the CLI reference for current behavior.

Use this site to:

  • install the package and inspect the current CLI surface
  • initialize and validate the packaged demos
  • inspect and run declared demo workflows
  • review the vocabulary for manifests, source indexes, hashes, output addresses, dependency scope, runtime artifacts, and provenance records

Start with Installation, then inspect the Colors Processing Demo.