stilt.config.MetConfig#

class stilt.config.MetConfig(*, directory: pathlib.Path, source: str | None = None, backend: Literal['s3', 'ftp', 'http'] = 's3', file_format: str | None = None, file_tres: str | None = None, n_min: int = 1, subgrid_enable: bool = False, subgrid_bounds: stilt.config.spatial.Bounds | None = None, subgrid_buffer: float = 0.2, subgrid_levels: int | None = None, subgrid_dir: pathlib.Path | None = None, **extra_data: Any) None[source]#

Meteorology file discovery, optional downloading, and optional subgridding.

Parameters#

Parameter

Description

Default

directory

Directory containing ARL meteorology files for this met stream.

Required

source

arlmet source name for automatic downloading from NOAA archives (e.g. ‘hrrr’, ‘nam12’, ‘gdas1’, ‘gfs0p25’). When set, file_format and file_tres are not required. Source-specific constructor arguments (e.g. domain=’ak’ for nams) may be specified as additional inline fields.

None

backend

Download backend when source is set. One of ‘s3’, ‘ftp’, or ‘http’.

's3'

file_format

Datetime format string used to discover meteorology filenames. Required when source is not set (archive mode).

None

file_tres

Nominal time spacing between meteorology files. Required when source is not set (archive mode).

None

n_min

Minimum number of meteorology files required for a run.

1

subgrid_enable

Enable meteorology subgridding before the run.

False

subgrid_bounds

Bounds used for meteorology subgridding.

None

subgrid_buffer

Buffer added around the receptor domain when subgridding meteorology.

0.2

subgrid_levels

Number of vertical levels to keep when subgridding meteorology.

None

subgrid_dir

Directory to cache subgridded met files. Defaults to <directory>/subgrid when not set. Shared across all simulations that use this met stream.

None