nifreeze.cli.parser module

Parser module.

nifreeze.cli.parser.parse_args(argv: list[str] | None = None) → tuple[Namespace, dict, dict, dict]

Parse the command line arguments and return a curated arguments.

Performs further checks to ensure that necessary data is provided for the estimation process.

Parameters:

argv (list, optional) – Arguments.

Returns:

• args (Namespace) – Populated namespace.

• extra_kwargs (dict) – Extra keyword arguments passed to the dataset.

• estimator_kwargs (dict) – Extra keyword arguments passed to the estimator.

• model_kwargs (dict) – Extra keyword arguments passed to the model.