nipoppy.config.BasePipelineConfig

class nipoppy.config.BasePipelineConfig(/, **data)

Base schema for processing/BIDS pipeline configuration.

Parameters:

data (Any)

get_fpath_container()

Return the path to the pipeline’s container.

Return type:

pathlib.Path

get_step_config(step_name=None)

Return the configuration for the given step.

If step_name is None, return the configuration for the first step.

Parameters:

step_name (Optional[str])

Return type:

nipoppy.config.pipeline_step.BasePipelineStepConfig

validate_after()

Validate the pipeline configuration after creation.

Specifically: - If STEPS has more than one item, make sure that each step has a unique name.

classmethod validate_before(data)

Validate the pipeline configuration before instantiation.

Specifically: - Apply substitutions for pipeline name/version in the config

Parameters:

data (Any)

Return type:

Any

CONTAINER_INFO: nipoppy.config.container.ContainerInfo = None

DESCRIPTION: str | None = None

NAME: str = None

STEPS: list[nipoppy.config.pipeline_step.BidsPipelineStepConfig | nipoppy.config.pipeline_step.ProcPipelineStepConfig | nipoppy.config.pipeline_step.ExtractionPipelineStepConfig] = None

VERSION: str = None