Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions docs/source/concepts/field/ensemble.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _ensemble_component:

Ensemble component
==================
Ensemble component and metadata keys
======================================

Every :py:class:`~earthkit.data.core.field.Field` may carry an *ensemble component* that
identifies which ensemble member the field belongs to. The ensemble component is accessible
Expand Down Expand Up @@ -40,7 +40,7 @@ or via :meth:`set` are converted automatically. ``None`` represents the absence
ensemble member (deterministic data).


Accessing ensemble information
List of ensemble metadata keys
-------------------------------

.. list-table::
Expand Down
4 changes: 2 additions & 2 deletions docs/source/concepts/field/field.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ retained in the result without modification:
True


How-tos
-------
Tutorials / How-tos
--------------------

- :ref:`/tutorials/field/field_overview.ipynb`
- :ref:`/tutorials/grib/grib_overview.ipynb`
Expand Down
13 changes: 3 additions & 10 deletions docs/source/concepts/field/geography.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _geography_component:

Geography component
===================
Geography component and metadata keys
===========================================

Every :py:class:`~earthkit.data.core.field.Field` carries a *geography component* that describes
the horizontal spatial coordinate system of the field. The geography component is accessible via
Expand Down Expand Up @@ -116,16 +116,9 @@ The ``dtype`` argument controls the output array type:
dtype('float32')



Accessing geography information
List of geography metadata keys
--------------------------------

All geography keys are accessible through :meth:`~earthkit.data.core.field.Field.get` with the
``"geography."`` prefix, and can therefore be used in
:meth:`~earthkit.data.core.fieldlist.FieldList.sel`,
:meth:`~earthkit.data.core.fieldlist.FieldList.order_by`, and
:meth:`~earthkit.data.core.fieldlist.FieldList.metadata`.

.. list-table::
:header-rows: 1
:widths: 32 68
Expand Down
12 changes: 3 additions & 9 deletions docs/source/concepts/field/parameter.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _parameter_component:

Parameter component
===================
Parameter component and metadata keys
=======================================

Every :py:class:`~earthkit.data.core.field.Field` carries a *parameter component* that describes
the physical quantity the field represents. The parameter component is accessible via the
Expand Down Expand Up @@ -58,15 +58,9 @@ The appropriate parameter subclass is determined automatically from the data:
``wave_frequency*`` keys).


Accessing parameter information
List of parameter metadata keys
--------------------------------

All parameter keys are accessible through :meth:`~earthkit.data.core.field.Field.get` with the
``"parameter."`` prefix, and can therefore be used in
:meth:`~earthkit.data.core.fieldlist.FieldList.sel`,
:meth:`~earthkit.data.core.fieldlist.FieldList.order_by`, and
:meth:`~earthkit.data.core.fieldlist.FieldList.metadata`.

.. list-table::
:header-rows: 1
:widths: 32 68
Expand Down
14 changes: 4 additions & 10 deletions docs/source/concepts/field/proc.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _proc_component:

Processing (proc) component
============================
Processing (proc) component and metadata keys
===============================================

.. warning::

Expand Down Expand Up @@ -66,14 +66,8 @@ Time processing methods
- Field values represent the maximum over the time span.


Accessing processing information
---------------------------------

All proc keys are accessible through :meth:`~earthkit.data.core.field.Field.get` with the
``"proc."`` prefix, and can therefore be used in
:meth:`~earthkit.data.core.fieldlist.FieldList.sel`,
:meth:`~earthkit.data.core.fieldlist.FieldList.order_by`, and
:meth:`~earthkit.data.core.fieldlist.FieldList.metadata`.
List of proc metadata keys
-----------------------------

.. list-table::
:header-rows: 1
Expand Down
14 changes: 4 additions & 10 deletions docs/source/concepts/field/time.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _time_component:

Time component
==============
Time component and metadata keys
===========================================

Every :py:class:`~earthkit.data.core.field.Field` carries a *time component* that describes the
temporal coordinate of the field. The time component is accessible via the :attr:`time` attribute
Expand Down Expand Up @@ -52,14 +52,8 @@ The appropriate time subclass is determined automatically from the data:
that also carries a ``forecast_month`` value.


Accessing time information
--------------------------

All time keys are accessible through :meth:`~earthkit.data.core.field.Field.get` with the
``"time."`` prefix, and can therefore be used in
:meth:`~earthkit.data.core.fieldlist.FieldList.sel`,
:meth:`~earthkit.data.core.fieldlist.FieldList.order_by`, and
:meth:`~earthkit.data.core.fieldlist.FieldList.metadata`.
List of time metadata keys
------------------------------

.. list-table::
:header-rows: 1
Expand Down
14 changes: 4 additions & 10 deletions docs/source/concepts/field/vertical.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _vertical_component:

Vertical component
==================
Vertical component and metadata keys
===========================================

Every :py:class:`~earthkit.data.core.field.Field` carries a *vertical component* that describes
where in the atmosphere, ocean, or land the field is defined. The vertical component is accessible
Expand Down Expand Up @@ -448,14 +448,8 @@ levels the vertical component exposes the following additional methods:
- :meth:`~earthkit.data.field.component.vertical.VerticalBase.number_of_levels` – total number of
model levels


Accessing vertical information
-------------------------------

All vertical keys are accessible through :meth:`~earthkit.data.core.field.Field.get` with the
``"vertical."`` prefix, and can therefore be used in :meth:`~earthkit.data.core.fieldlist.FieldList.sel`,
:meth:`~earthkit.data.core.fieldlist.FieldList.order_by`, and
:meth:`~earthkit.data.core.fieldlist.FieldList.metadata`.
List of vertical metadata keys
--------------------------------

Supported keys:

Expand Down
16 changes: 9 additions & 7 deletions docs/source/release-notes/version_1.0_updates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,22 @@ Component-based Field metadata
format-independent, polymorphic *components*, each responsible for a distinct aspect of
the field's metadata:

- :ref:`parameter_component` — physical quantity, units, CF names; extended with chemical, optical, and wave-spectra sub-types.
- :ref:`time_component` — base datetime, forecast step, valid datetime.
- :ref:`vertical_component` — level value, level type, layer bounds, parametric (hybrid) level coefficients.
- :ref:`geography_component` — lat/lon arrays, bounding box, projection, grid type.
- :ref:`ensemble_component` — ensemble member identifier.
- :ref:`proc_component` — post-processing operations (e.g. accumulation type and time span).
- :ref:`labels_component` — user-defined key-value pairs.
- :ref:`Parameter component <parameter_component>` — physical quantity, units, CF names; extended with chemical, optical, and wave-spectra sub-types.
- :ref:`Time component <time_component>` — base datetime, forecast step, valid datetime.
- :ref:`Vertical component <vertical_component>` — level value, level type, layer bounds, parametric (hybrid) level coefficients.
- :ref:`Geography component <geography_component>` — lat/lon arrays, bounding box, projection, grid type.
- :ref:`Ensemble component <ensemble_component>` — ensemble member identifier.
- :ref:`Processing (proc) component <proc_component>` — post-processing operations (e.g. accumulation type and time span).
- :ref:`Labels component <labels_component>` — user-defined key-value pairs.

Components are accessed via field attributes (e.g. ``field.time``) or through the generic
:meth:`~earthkit.data.core.field.Field.get` method using ``"component.key"`` strings. Raw
source-native keys (e.g. GRIB ``shortName``) remain accessible via
:meth:`~earthkit.data.core.field.Field.metadata` or with the ``"metadata."`` prefix in
:meth:`~earthkit.data.core.field.Field.get`.

The :ref:`field_keys` page provides a full list of all available component metadata keys.

See the :ref:`field_concept` page for full details.

Notebook examples:
Expand Down
35 changes: 25 additions & 10 deletions docs/source/tutorials/field/field_overview.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -438,10 +438,13 @@
"slideshow": {
"slide_type": ""
},
"tags": []
"tags": [],
"vscode": {
"languageId": "raw"
}
},
"source": [
"The :ref:`parameter_component` describes the physical quantity the field represents."
"The :ref:`parameter component <parameter_component>` describes the physical quantity the field represents."
]
},
{
Expand Down Expand Up @@ -503,10 +506,13 @@
"slideshow": {
"slide_type": ""
},
"tags": []
"tags": [],
"vscode": {
"languageId": "raw"
}
},
"source": [
"The :ref:`time_component` describes the temporal coordinate: base datetime, forecast step, and valid datetime."
"The :ref:`time component <time_component>` describes the temporal coordinate: base datetime, forecast step, and valid datetime."
]
},
{
Expand Down Expand Up @@ -566,10 +572,13 @@
"slideshow": {
"slide_type": ""
},
"tags": []
"tags": [],
"vscode": {
"languageId": "raw"
}
},
"source": [
"The :ref:`vertical_component` describes where in the atmosphere, ocean, or land the field is defined."
"The :ref:`vertical component <vertical_component>` describes where in the atmosphere, ocean, or land the field is defined."
]
},
{
Expand Down Expand Up @@ -631,10 +640,13 @@
"slideshow": {
"slide_type": ""
},
"tags": []
"tags": [],
"vscode": {
"languageId": "raw"
}
},
"source": [
"The :ref:`geography_component` describes the horizontal grid: shape, bounding box, projection, and coordinates."
"The :ref:`geography component <geography_component>` describes the horizontal grid: shape, bounding box, projection, and coordinates."
]
},
{
Expand Down Expand Up @@ -700,10 +712,13 @@
"slideshow": {
"slide_type": ""
},
"tags": []
"tags": [],
"vscode": {
"languageId": "raw"
}
},
"source": [
"The :ref:`labels_component` holds user-defined key-value pairs. Unlike the other components, labels are **not** populated from the source data — they start empty and are filled by the user."
"The :ref:`labels component <labels_component>` holds user-defined key-value pairs. Unlike the other components, labels are **not** populated from the source data — they start empty and are filled by the user."
]
},
{
Expand Down
Loading