dummy/csv dummy/csv

dummy/csv dummy/csv#

Description#

Synthetic/toy meteorology plugin for the dummy Gaussian-plume test model.

Meteorology is stored as per-period CSV files with windspeed, winddir and stabclass columns, one row per time step. If a requested source file is missing, it is generated on the fly with random values (uniform wind speed and direction, random Pasquill stability class), optionally seeded deterministically via seed/seed_id for reproducibility. This plugin does not read real meteorological data; it only serves to drive the simple dispersion test model without external input.

YAML arguments#

The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:

Optional arguments#

dir : str, optional, default “”

Path to the corresponding component. This value is used if not provided in parameters

file : str, optional, default “dummy_meteo_%Y%m%d%H00.txt”

File format for the fluxes

varname : str, optional, default “”

Variable name to use to read data filesinstead of the parameter name if different to the parameter name

file_freq : str, optional, default “24h”

Frequency at which files are split

split_freq : str, optional

Re-bucket this tracer’s fetched dates/files onto a fixed pandas-frequency grid (e.g. '1D', '1MS', '1YS'), independently of the native frequency the files were found at (file_freq). This fixes the sub-simulation boundaries that fromcontrol inherits for this tracer. For minimal memory usage, match it to the consuming model’s own periodicity: a finer value costs an extra time_interpolation bridge for no memory benefit, while a coarser value keeps the tracer’s data resident in memory across every one of the model’s sub-simulations it spans. See the ‘Splitting the temporal grid’ section on the observation operator page for the full mechanism and worked examples.

seed : bool, optional, default False

Use random generation of meteo parameters

seed_id : int, optional, default 0

ID for the numpy seed to be used

resolution : str, optional, default “1h”

Temporal resolution of the meteorology

Requirements#

The current plugin requires the present plugins to run properly:

Requirement name

Requirement type

Explicit definition

Any valid

Default name

Default version

domain

Domain

False

False

dummy

std

YAML template#

Please find below a template for a YAML configuration:

 1meteo:
 2  plugin:
 3    name: dummy
 4    version: csv
 5    type: meteo
 6
 7  # Optional arguments
 8  dir: XXXXX  # str
 9  file: XXXXX  # str
10  varname: XXXXX  # str
11  file_freq: XXXXX  # str
12  split_freq: XXXXX  # str
13  seed: XXXXX  # bool
14  seed_id: XXXXX  # int
15  resolution: XXXXX  # str

See also

API reference (functions & code)