Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
bb9fcc5
"wavelength" and "chem_long_name" keys added to Parameter component o…
pawel-wolff May 29, 2026
4c115c3
"wave_direction" and "wave_frequency" keys added to Parameter compone…
pawel-wolff May 29, 2026
ef97d5c
Four dimensions and dim roles added: chem_varialbe, wavelength, wave_…
pawel-wolff Jun 1, 2026
ce495cd
"standard_name" attr for "chem_variable" and "wavelength" coordinate …
pawel-wolff Jun 1, 2026
4630029
sorting logic for coordinate of Xarray dimensions fixed in XarrayInpu…
pawel-wolff Jun 1, 2026
319dc58
New how-to notebooks updated
pawel-wolff Jun 2, 2026
1f42de3
Docstring for `Parameter` class updated
pawel-wolff Jun 2, 2026
d59412a
Cleanup
pawel-wolff Jun 2, 2026
4e7c668
chem_variable -> chem
pawel-wolff Jun 5, 2026
559e505
Vertical: __print__() -> __str__()
pawel-wolff Jun 5, 2026
7d42c32
Parameter is subclassed
pawel-wolff Jun 8, 2026
c3f698d
Inspection of the `__init__()` signature of `ParameterBase` subclasse…
pawel-wolff Jun 9, 2026
d0e2578
New metadata keys added to the parameter component of Field: waveleng…
pawel-wolff Jun 9, 2026
b271c5d
Docstrings for set() and from_dict() for parameter component updated …
pawel-wolff Jun 9, 2026
cef8855
The keys added: wavelength_units, wave_direction_units, wave_frequenc…
pawel-wolff Jun 9, 2026
ab398f5
wavelength, wave_direction, wave_frequency and their bounds accept op…
pawel-wolff Jun 10, 2026
3a78760
docstrings fixed
pawel-wolff Jun 10, 2026
d3d1ffc
_normalise_create_kwargs fixed when called with `allow_keys=None`
pawel-wolff Jun 10, 2026
0da557d
Mapping the following parameter metadata keys to GRIB: variable, chem…
pawel-wolff Jun 10, 2026
005b045
Notebooks and docs updated
pawel-wolff Jun 10, 2026
4681f2f
Merge from develop
pawel-wolff Jun 11, 2026
669a426
Final fixes
pawel-wolff Jun 11, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/source/concepts/xarray/dim.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ Predefined dimensions and dimension roles
By default, the following predefined dimensions are generated, in the following order:

- ensemble forecast member dimension
- aerosol type, or atmospheric chemical or physical constituent type
(discrete dimension, applicable for chemical parameters; see details :ref:`here <_xr_chem_optical_dims>`)
- optical depth or wavelength range or colour channel (applicable for optical parameters,
simulated satellite images, etc.; see details :ref:`here <_xr_chem_optical_dims>`)
- direction and frequency of sea waves (applicable for 2D wave spectra parameters;
see details :ref:`here <_xr_wave_spectra_dims>`)
- temporal dimensions, controlled by ``time_dims`` (see details :ref:`here <xr_time_dims>`)
- vertical dimensions, controlled by ``level_dim_mode`` (see details :ref:`here <xr_level_dim_modes>`)

Expand All @@ -29,6 +35,18 @@ The predefined dimensions are based on the ``dim_roles``, which is a mapping bet
* - "member"
- Ensemble forecast member
- "ensemble.member"
* - "chem"
- Aerosol type, or chemical or physical constituent type
- "parameter.chem"
* - "wavelength"
- Optical wavelength (e.g. for aerosol optical depth)
- "parameter.wavelength"
* - "wave_direction"
- Wave direction (for 2D wave spectra)
- "parameter.wave_direction"
* - "wave_frequency"
- Wave frequency (for 2D wave spectra)
- "parameter.wave_frequency"
* - "forecast_reference_time"
- Forecast reference time (base datetime). Can be a single metadata key, or a list/tuple of two metadata keys representing the "date" and "time" parts of the forecast reference time. Alternatively, it can be a dict with "date" and "time" keys specifying the corresponding metadata keys. Used when ``"forecast_reference_time"`` is in ``time_dims``.
- "time.forecast_reference_time"
Expand Down Expand Up @@ -134,6 +152,38 @@ The following example demonstrates the vertical dimensions modes:
- :ref:`/how-tos/xr_engine/xarray_engine_level.ipynb`


.. _xr_chem_optical_dims:

Chemical and optical dimensions
------------------------------------------------

The following dimensions are applicable for chemical and optical parameters (see for example CAMS datasets):

- ``"chem"``: Indicates an aerosol type, chemical specie, etc. (for example, for the parameter representing *mass mixing ratio*, the coordinates can be ``"CO"``, ``"O3"``, etc.).

- ``"wavelength"``: Wavelength at which the optical parameter is measured, modelled or reported.

The following notebook illustrates the use of the above dimensions in a CAMS dataset containing chemical and optical parameters:

- :ref:`/how-tos/xr_engine/xarray_engine_chem.ipynb`


.. _xr_wave_spectra_dims:

2D wave spectra dimensions
------------------------------------------------

The following dimensions are applicable for 2D wave spectra parameters:

- ``"wave_direction"``: Direction from which the waves propagate, expressed in degrees clockwise from true north.

- ``"wave_frequency"``: Wave frequency corresponding to the spectral component.

The following notebook presents an example 2D wave spectra dataset:

- :ref:`/how-tos/xr_engine/xarray_engine_wave_spectra.ipynb`


.. _xr_squeeze_and_ensure_dims:


Expand Down
2 changes: 2 additions & 0 deletions docs/source/how-tos/xr_engine/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Xarray engine
xarray_engine_seasonal.ipynb
xarray_engine_level.ipynb
xarray_engine_ensemble.ipynb
xarray_engine_chem.ipynb
xarray_engine_wave_spectra.ipynb
xarray_engine_variable_key.ipynb
xarray_engine_mono_variable.ipynb
xarray_engine_mono_variable_remapping.ipynb
Expand Down
Loading
Loading