stilt.config.RuntimeSettings#

class stilt.config.RuntimeSettings(_case_sensitive: 'bool | None' = None, _nested_model_default_partial_update: 'bool | None' = None, _env_prefix: 'str | None' = None, _env_prefix_target: 'EnvPrefixTarget | None' = None, _env_file: 'DotenvType | None' = PosixPath('.'), _env_file_encoding: 'str | None' = None, _env_ignore_empty: 'bool | None' = None, _env_nested_delimiter: 'str | None' = None, _env_nested_max_split: 'int | None' = None, _env_parse_none_str: 'str | None' = None, _env_parse_enums: 'bool | None' = None, _cli_prog_name: 'str | None' = None, _cli_parse_args: 'bool | list[str] | tuple[str, ...] | None' = None, _cli_settings_source: 'CliSettingsSource[Any] | None' = None, _cli_parse_none_str: 'str | None' = None, _cli_hide_none_type: 'bool | None' = None, _cli_avoid_json: 'bool | None' = None, _cli_enforce_required: 'bool | None' = None, _cli_use_class_docs_for_groups: 'bool | None' = None, _cli_exit_on_error: 'bool | None' = None, _cli_prefix: 'str | None' = None, _cli_flag_prefix_char: 'str | None' = None, _cli_implicit_flags: "bool | Literal['dual', 'toggle'] | None" = None, _cli_ignore_unknown_args: 'bool | None' = None, _cli_kebab_case: "bool | Literal['all', 'no_enums'] | None" = None, _cli_shortcuts: 'Mapping[str, str | list[str]] | None' = None, _secrets_dir: 'PathType | None' = None, _build_sources: 'tuple[tuple[PydanticBaseSettingsSource, ...], dict[str, Any]] | None' = None, *, db_url: str | None = None, cache_dir: pathlib.Path | None = None, compute_root: pathlib.Path | None = None) → None[source]#

Queue, cache, and scratch locations for a deployment.

Each field is read from the matching PYSTILT_* environment variable (PYSTILT_DB_URL and so on) unless passed directly. None of them change a simulation’s result.

Parameters#

Parameter	Description	Default
`db_url`	PostgreSQL URL of the shared work queue.	`None`
`cache_dir`	Local directory for files downloaded from a cloud project. Unset uses a new temporary directory.	`None`
`compute_root`	Directory where workers run HYSPLIT before copying outputs into the project. Unset runs inside a local project, and under `$TMPDIR/pystilt/` for a cloud project.	`None`

Methods#

settings_customise_sources(settings_cls, ...)

Define the sources and their order for loading the settings values.