Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

Toggle table of contents sidebar

Overview

Installation
Quickstart
User guide
Toggle navigation of User guide

How-to guides

Initializing a new dataset
Toggle navigation of Initializing a new dataset
- Starting with non-BIDS data
- Starting with BIDS data

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.main
      Toggle navigation of nipoppy.config.main
      - nipoppy.config.main.Config
    - 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.env
    Toggle navigation of nipoppy.env
    - nipoppy.env.LogColor
    - nipoppy.env.ReturnCode
  - nipoppy.layout
    Toggle navigation of nipoppy.layout
  - nipoppy.logger
  - 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.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.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.BasePipelineWorkflow
    - nipoppy.workflows.BaseWorkflow
    - nipoppy.workflows.BidsConversionRunner
    - nipoppy.workflows.DicomReorgWorkflow
    - nipoppy.workflows.ExtractionRunner
    - nipoppy.workflows.InitWorkflow
    - nipoppy.workflows.PipelineRunner
    - nipoppy.workflows.PipelineTracker
    - nipoppy.workflows.StatusWorkflow
    - nipoppy.workflows.TrackCurationWorkflow
File schemas

Other

What’s new
Contributing
Glossary

Toggle table of contents sidebar

nipoppy.env.ReturnCode¶

class nipoppy.env.ReturnCode¶

Return codes used for the CLI commands.

PARTIAL_SUCCESS = 64¶

SUCCESS = 0¶

UNKOWN_FAILURE = 1¶

nipoppy.env.LogColor

Copyright © 2024, NeuroDataScience-ORIGAMI Lab

Made with Sphinx and @pradyunsg's Furo

On this page

nipoppy.env.ReturnCode
- nipoppy.env.ReturnCode