LMDz restart concentrations LMDZ/ic

Description

Reads/writes LMDz restart-file initial concentrations (start.nc-style files).

The species variable is resolved either from the chemical scheme’s restart_id (looked up from self.chemistry.acspecies) or from an explicit restart_id/varnames argument on the tracer.

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 “”

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 “”

Temporal frequency to fetch files

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.

restart_id : str or int, optional

ID of the species in the restart file. Should be specified if different from the chemical scheme.

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	LMDZ	std
chemistry	Chemistry	False	False	CHIMERE	gasJtab

YAML template

Please find below a template for a YAML configuration:

field:
  plugin:
    name: LMDZ
    version: ic
    type: field

  # Optional arguments
  dir: XXXXX  # str
  file: XXXXX  # str
  varname: XXXXX  # str
  file_freq: XXXXX  # str
  split_freq: XXXXX  # str
  restart_id: XXXXX  # <class 'str'>|<class 'int'>

See also

API reference (functions & code)