pestifer.subcommands.fetch_example module

The fetch-example subcommand. Copies a specific example’s YAML configuration file to the current working directory.

class pestifer.subcommands.fetch_example.FetchExampleSubcommand(name: str = 'fetch-example', aliases: list = <factory>, log_file: str = 'pestifer_diagnostics.log', short_help: str = "copy the example's YAML config file to the CWD", long_help: str = "Fetch the YAML configuration file for a specific example by its ID. This command will copy the example's configuration file to the current working directory, allowing you to run simulations or analyses based on that configuration.", func_returns_type: type = <class 'str'>, parser: argparse.ArgumentParser = None)

Bases: Subcommand

add_subparser(subparsers)

Adds the subcommand parser to the given subparsers. Subclasses declare arguments here, after a super().add_subparser() call.

static func(args: Namespace, **kwargs)

the function that executes the subcommand. Subclasses must implement this method.

func_returns_type

alias of str

long_help: str = "Fetch the YAML configuration file for a specific example by its ID. This command will copy the example's configuration file to the current working directory, allowing you to run simulations or analyses based on that configuration."

description

name: str = 'fetch-example'

subcommand name

short_help: str = "copy the example's YAML config file to the CWD"

help string