ICON-ART initial and lateral boundary conditions ICON-ART/icbc#
Description#
Reads ICON-ART initial condition, lateral boundary condition (lbc) and
background NetCDF files.
fetch distinguishes between a single initial-condition file
(component.orig_name in "inicond"/"restart_inicond") and a
sequence of boundary-condition files spaced by file_freq
("lbc"/"background"); read makes the same distinction via the
comp_type argument. write is not implemented for this format; it
always raises CifError.
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:
Mandatory arguments#
- comp_type : “inicond” or “lbc” or “background”, mandatory
Type of conditions to fetch
Optional arguments#
- dir : str, optional, default “”
Path to the corresponding component. This value is used if not provided in parameters
- file : str, optional, default “”
File format in the given directory. This value is used if not provided in parameters
- 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 “3h”
Temporal frequency at which input files are available. Does not indicate the temporal resolution within each file. Valid only for comp_type=lbc.
- 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 thatfromcontrolinherits for this tracer. For minimal memory usage, match it to the consuming model’s own periodicity: a finer value costs an extratime_interpolationbridge 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.
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 |
ICON-ART |
std |
YAML template#
Please find below a template for a YAML configuration:
1field:
2 plugin:
3 name: ICON-ART
4 version: icbc
5 type: field
6
7 # Mandatory arguments
8 comp_type: XXXXX # inicond|lbc|background
9
10 # Optional arguments
11 dir: XXXXX # str
12 file: XXXXX # str
13 varname: XXXXX # str
14 file_freq: XXXXX # str
15 split_freq: XXXXX # str
See also