Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

Toggle table of contents sidebar

Overview

Why Nipoppy?
Toggle navigation of Why Nipoppy?
- The principles
- The use cases
Installation
Quickstart

Tutorials

Run MRIQC on a BIDS dataset

Explanations

The manifest file

How-to guides

User guide (legacy)
Toggle navigation of User guide (legacy)
Initializing a new dataset
Toggle navigation of Initializing a new dataset
- Starting with non-BIDS data
- Starting with BIDS data
Creating the manifest file
Toggle navigation of Creating the manifest file
Adding a pipeline to a dataset
Running a pipeline

Reference

Command-line interface
Toggle navigation of Command-line interface
Python API
Toggle navigation of Python API
- nipoppy
  Toggle navigation of nipoppy
  - nipoppy.base
    Toggle navigation of nipoppy.base
    - nipoppy.base.Base
  - nipoppy.config
    Toggle navigation of nipoppy.config
    - nipoppy.config.boutiques
      Toggle navigation of nipoppy.config.boutiques
      - nipoppy.config.boutiques.BoutiquesConfig
    - nipoppy.config.container
      Toggle navigation of nipoppy.config.container
      - nipoppy.config.container.ContainerConfig
      - nipoppy.config.container.ContainerInfo
    - nipoppy.config.hpc
      Toggle navigation of nipoppy.config.hpc
      - nipoppy.config.hpc.HpcConfig
    - nipoppy.config.main
      Toggle navigation of nipoppy.config.main
      - nipoppy.config.main.Config
      - nipoppy.config.main.PipelineVariables
    - nipoppy.config.pipeline
      Toggle navigation of nipoppy.config.pipeline
    - nipoppy.config.pipeline_step
      Toggle navigation of nipoppy.config.pipeline_step
    - nipoppy.config.tracker
      Toggle navigation of nipoppy.config.tracker
      - nipoppy.config.tracker.TrackerConfig
    - nipoppy.config.BasePipelineConfig
    - nipoppy.config.BasePipelineStepConfig
    - nipoppy.config.BidsPipelineConfig
    - nipoppy.config.BidsPipelineStepConfig
    - nipoppy.config.BoutiquesConfig
    - nipoppy.config.Config
    - nipoppy.config.ContainerConfig
    - nipoppy.config.ProcPipelineConfig
    - nipoppy.config.ProcPipelineStepConfig
    - nipoppy.config.TrackerConfig
  - nipoppy.console
  - nipoppy.env
    Toggle navigation of nipoppy.env
  - nipoppy.layout
    Toggle navigation of nipoppy.layout
  - nipoppy.logger
  - nipoppy.pipeline_validation
  - nipoppy.tabular
    Toggle navigation of nipoppy.tabular
    - nipoppy.tabular.base
      Toggle navigation of nipoppy.tabular.base
      - nipoppy.tabular.base.BaseTabular
      - nipoppy.tabular.base.BaseTabularModel
    - nipoppy.tabular.curation_status
      Toggle navigation of nipoppy.tabular.curation_status
      - nipoppy.tabular.curation_status.CurationStatusModel
      - nipoppy.tabular.curation_status.CurationStatusTable
    - nipoppy.tabular.dicom_dir_map
      Toggle navigation of nipoppy.tabular.dicom_dir_map
      - nipoppy.tabular.dicom_dir_map.DicomDirMap
      - nipoppy.tabular.dicom_dir_map.DicomDirMapModel
    - nipoppy.tabular.manifest
      Toggle navigation of nipoppy.tabular.manifest
      - nipoppy.tabular.manifest.Manifest
      - nipoppy.tabular.manifest.ManifestModel
    - nipoppy.tabular.processing_status
      Toggle navigation of nipoppy.tabular.processing_status
      - nipoppy.tabular.processing_status.ProcessingStatusModel
      - nipoppy.tabular.processing_status.ProcessingStatusTable
    - nipoppy.tabular.CurationStatusTable
    - nipoppy.tabular.Manifest
    - nipoppy.tabular.ProcessingStatusTable
  - nipoppy.utils
  - nipoppy.workflows
    Toggle navigation of nipoppy.workflows
    - nipoppy.workflows.base
      Toggle navigation of nipoppy.workflows.base
      - nipoppy.workflows.base.BaseDatasetWorkflow
      - nipoppy.workflows.base.BaseWorkflow
    - nipoppy.workflows.bids_conversion
      Toggle navigation of nipoppy.workflows.bids_conversion
      - nipoppy.workflows.bids_conversion.BidsConversionRunner
    - nipoppy.workflows.dataset_init
      Toggle navigation of nipoppy.workflows.dataset_init
      - nipoppy.workflows.dataset_init.InitWorkflow
    - nipoppy.workflows.dataset_status
      Toggle navigation of nipoppy.workflows.dataset_status
      - nipoppy.workflows.dataset_status.StatusWorkflow
    - nipoppy.workflows.dicom_reorg
      Toggle navigation of nipoppy.workflows.dicom_reorg
      - nipoppy.workflows.dicom_reorg.DicomReorgWorkflow
    - nipoppy.workflows.extractor
      Toggle navigation of nipoppy.workflows.extractor
      - nipoppy.workflows.extractor.ExtractionRunner
    - nipoppy.workflows.pipeline
      Toggle navigation of nipoppy.workflows.pipeline
      - nipoppy.workflows.pipeline.BasePipelineWorkflow
    - nipoppy.workflows.pipeline_store
      Toggle navigation of nipoppy.workflows.pipeline_store
      - nipoppy.workflows.pipeline_store.create
        Toggle navigation of nipoppy.workflows.pipeline_store.create
        
        nipoppy.workflows.pipeline_store.create.PipelineCreateWorkflow
      - nipoppy.workflows.pipeline_store.install
        Toggle navigation of nipoppy.workflows.pipeline_store.install
        
        nipoppy.workflows.pipeline_store.install.PipelineInstallWorkflow
      - nipoppy.workflows.pipeline_store.list
        Toggle navigation of nipoppy.workflows.pipeline_store.list
        
        nipoppy.workflows.pipeline_store.list.PipelineListWorkflow
      - nipoppy.workflows.pipeline_store.search
        Toggle navigation of nipoppy.workflows.pipeline_store.search
        
        nipoppy.workflows.pipeline_store.search.PipelineSearchWorkflow
      - nipoppy.workflows.pipeline_store.validate
        Toggle navigation of nipoppy.workflows.pipeline_store.validate
        
        nipoppy.workflows.pipeline_store.validate.PipelineValidateWorkflow
      - nipoppy.workflows.pipeline_store.zenodo
        Toggle navigation of nipoppy.workflows.pipeline_store.zenodo
        
        nipoppy.workflows.pipeline_store.zenodo.ZenodoUploadWorkflow
    - nipoppy.workflows.runner
      Toggle navigation of nipoppy.workflows.runner
      - nipoppy.workflows.runner.PipelineRunner
    - nipoppy.workflows.track_curation
      Toggle navigation of nipoppy.workflows.track_curation
      - nipoppy.workflows.track_curation.TrackCurationWorkflow
    - nipoppy.workflows.tracker
      Toggle navigation of nipoppy.workflows.tracker
      - nipoppy.workflows.tracker.PipelineTracker
    - nipoppy.workflows.BaseDatasetWorkflow
    - nipoppy.workflows.BasePipelineWorkflow
    - nipoppy.workflows.BaseWorkflow
    - nipoppy.workflows.BidsConversionRunner
    - nipoppy.workflows.DicomReorgWorkflow
    - nipoppy.workflows.ExtractionRunner
    - nipoppy.workflows.InitWorkflow
    - nipoppy.workflows.PipelineInstallWorkflow
    - nipoppy.workflows.PipelineListWorkflow
    - nipoppy.workflows.PipelineRunner
    - nipoppy.workflows.PipelineTracker
    - nipoppy.workflows.PipelineValidateWorkflow
    - nipoppy.workflows.StatusWorkflow
    - nipoppy.workflows.TrackCurationWorkflow
  - nipoppy.zenodo_api
    Toggle navigation of nipoppy.zenodo_api
File schemas

Other

What’s new
Contributing
Glossary

Toggle table of contents sidebar

nipoppy.env.ContainerCommandEnum¶

class nipoppy.env.ContainerCommandEnum¶

Container commands.

APPTAINER = 'apptainer'¶

SINGULARITY = 'singularity'¶

nipoppy.env.LogColor

Copyright © 2024, NeuroDataScience-ORIGAMI Lab

Made with Sphinx and @pradyunsg's Furo

On this page

nipoppy.env.ContainerCommandEnum
- nipoppy.env.ContainerCommandEnum
  - nipoppy.env.ContainerCommandEnum.APPTAINER
  - nipoppy.env.ContainerCommandEnum.SINGULARITY