Retrieve config

Extract the default configuration file for each module.

By default presents the parameters from the three expertise levels:

basic, intermediate, and guru.

Usage:

haddock3-cfg  # prints only the general parametes
haddock3-cfg -g  # same as above
haddock3-cfg -m MODULE  # prints only the module parameters
haddock3-cfg -m MODULE -l LEVEL
haddock3-cfg -m topoaa -l all
haddock3-cfg -m rigidbody -l all -g  # prints the module and the globals

haddock.clis.cli_cfg.cli(ap: ArgumentParser, main: Callable[[...], None]) → None

Command-line interface entry point.

haddock.clis.cli_cfg.load_args(ap: ArgumentParser) → Namespace

Load argument parser args.

haddock.clis.cli_cfg.main(module: str | None = None, explevel: str = 'all', global_params: bool = True, details: bool = False) → None

Extract the defaults in the form of a run configuration file.

Parameters:

• module (str or None) – The module name to extract the defaults from. If None given, we expect global_params to be True, otherwise nothing will be printed.

• explevel (str) – Filter the parameters according to the expert level. Output all parameters that belong to the referred level or below. Choices are: all, easy, expert, and guru.

• global_params (bool) – Whether to add the module’s general global parameter. If True and module is None, outputs only the general parameters.

• details (bool) – Whether to add the ‘long’ description of each parameter.

haddock.clis.cli_cfg.maincli() → None

Execute main client.