py21cmfast.cli.RunParams

class py21cmfast.cli.RunParams

Common parameters for run functions.

cache_strategy: Literal['on', 'off', 'noloop', 'dmfield', 'last_step_only'] = 'dmfield'

A strategy for which fields to cache (only used for coeval and lightcones). Options are: (on) cache everything, (off) cache nothing (noloop) cache only boxes outside the astrophysics evolution loop (dmfield) alias for noloop (last_step_only) cache only boxes that are required more than one step away

cachedir: cyclopts.types.ExistingDirectory

Where to write and search for cached items and output fullspec configuration files. Note that caches will be in hash-style folders inside this folder.

outcfg: Annotated[pathlib.Path, Parameter(validator=vld.Path(file_okay=False, dir_okay=False, ext='toml'))] = None

A filepath where the full configuration TOML of the run can be written. Random hash if not specified.

param_selection: ParameterSelection

progress: bool = True

Whether to display a progress bar as the simulation runs.

regenerate: Annotated[bool, Parameter(name=['--regenerate', '--regen'])] = False

Whether to regenerate all data, even if found in cache.

seed: int = 42

Random seed used to generate data.

verbosity: Annotated[Literal['CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG'], Parameter(alias='-v', '--v')] = 'WARNING'

How much information to print out while running the simulation.