Dummy model - text dummy/txt#
Description#
Simple plain-text flux format for the dummy Gaussian test model.
Fluxes are stored as one comma-delimited 2D text file per period, with an
array shape matching the domain’s (nlat, nlon). If a requested file is
missing, it is not treated as an error: the flux field is generated on the
fly instead, via the nested make sub-package, either from a formula
(flx_formula) evaluated on the domain coordinates, or by rendering a
text string (flx_text) onto the domain grid.
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_flx.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 “”
Temporal frequency to fetch files
- split_freq : str, optional
Force splitting the processing at a given frequency different to file_freq
- period : str, optional, default “1D”
Frequency of the original fluxes
- freq : str, optional, default “1D”
Frequency of the original fluxes
Requirements#
The current plugin requires the present plugins to run properly:
Requirement name |
Requirement type |
Explicit definition |
Any valid |
Default name |
Default version |
|---|---|---|---|---|---|
domain |
False |
False |
dummy |
std |
YAML template#
Please find below a template for a YAML configuration:
1flux:
2 plugin:
3 name: dummy
4 version: txt
5 type: flux
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 period: XXXXX # str
14 freq: XXXXX # str
See also