Skip to content

commands

Definition of non-processing subcommands.

info_cmd

info_cmd(conf: Config) -> None

Print basic information about StagYY run.

var_cmd

var_cmd(conf: Config) -> None

Print a list of available variables.

See stagpy.phyvars where the lists of variables organized by command are defined.

version_cmd

version_cmd(conf: Config) -> None

Print StagPy version.

Use stagpy.__version__ to obtain the version in a script.

config_pp

config_pp(subs: Iterable[str], conf: Config) -> None

Pretty print of configuration options.

Parameters:

Name Type Description Default
subs Iterable[str]

conf sections to print.

required
conf Config

configuration.

required

config_cmd

config_cmd(conf: Config) -> None

Configuration handling.