nipoppy.config.ContainerConfig

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

Schema for container configuration.

Does not include information about the container image.

Parameters:

data (Any)

add_bind_path(path_local, path_inside_container=None, mode='rw')

Add a bind path.

Parameters:

  • path_local (nipoppy.env.StrOrPathLike)

  • path_inside_container (Optional[nipoppy.env.StrOrPathLike])

  • mode (str)

merge(other, overwrite_command=False)

Combine with another ContainerConfig instance.

By default this only changes arguments and environment variables, and no information is overwritten: - Arguments from other are appended to arguments of the current instance - Environment variables from other do not overwrite those of the current instance

If overwrite_command is True, the command of the current instance is replaced with that of the other instance.

Parameters:

other (Any)

ARGS: list[str] = None
COMMAND: str = None
ENV_VARS: dict[str, str] = None
INHERIT: bool = None
model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].