Skip to content

Doc on "Level types" updated #1042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sandorkertesz merged 1 commit into from
Jun 26, 2026
Merged

Doc on "Level types" updated #1042

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
80 changes: 40 additions & 40 deletions docs/source/concepts/field/vertical.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ following metadata:
- **standard_name** – CF standard name (e.g. ``"air_pressure"``)
- **long_name** – human-readable description
- **units** – native units of the level value
- **layer** – ``True`` when the type represents a layer (two bounding levels) rather than a single level
- **level** – indicates which bound is the *representative* level: ``"top"``, ``"bottom"``, or None string when undefined
- **positive** – vertical direction in which values increase: ``"up"``, ``"down"``, or None when undefined
- **layer** – ``True`` only when both the bottom and top bounding surfaces are defined, i.e. the level type describes a proper layer between two bounds; ``False`` when only one or neither bounding surface is specified (see for example ``"low_cloud_layer"`` vs ``"medium_cloud_layer"``)
- **level** – indicates which bound is the *representative* level: ``"top"``, ``"bottom"``, or ``None`` when undefined
- **positive** – vertical direction in which values increase: ``"up"``, ``"down"``, or ``None`` when undefined

When earthkit-data encounters a level type that is not in the predefined list below, it is
automatically registered at runtime so that arbitrary model-specific level types are handled
Expand All @@ -79,15 +79,15 @@ Predefined level types
- Level
- Positive
* - ``abstract_single_level``
- abstract_single_level
-
- abstract single level
- ``abstractSingleLevel``
-
- No
-
-
* - ``cloud_base``
- cloud_base
-
- cloud base
- ``cloudBase``
-
Expand Down Expand Up @@ -119,34 +119,34 @@ Predefined level types
- bottom
- down
* - ``entire_atmosphere``
- entire_atmosphere
-
- entire atmosphere
- ``entire_atmosphere``
-
- No
-
-
* - ``entire_lake``
- entire_lake
-
- entire lake
- ``entireLake``
-
- No
-
-
* - ``entire_melt_pond``
- entire_melt_pond
-
- entire melt pond
- ``entireMeltPond``
-
- No
-
-
* - ``general``
- general
-
- general
- ``gen``
-
- 1
- No
-
- down
Expand All @@ -167,7 +167,7 @@ Predefined level types
-
- up
* - ``high_cloud_layer``
- high_cloud_layer
-
- high cloud layer
- ``highCloudLayer``
- hPa
Expand All @@ -179,67 +179,67 @@ Predefined level types
- hybrid level
- ``ml``
- 1
- No (parametric)
- No
-
- down
* - ``ice_layer_on_water``
- ice_layer_on_water
-
- ice layer on water
- ``iceLayerOnWater``
-
- No
-
-
* - ``ice_top_on_water``
- ice_top_on_water
-
- ice top on water
- ``iceTopOnWater``
-
- No
-
-
* - ``lake_bottom``
- lake_bottom
-
- lake bottom
- ``lakeBottom``
-
- No
-
-
* - ``low_cloud_layer``
- low_cloud_layer
-
- low cloud layer
- ``lowCloudLayer``
- hPa
- No
- bottom
- down
* - ``mean_sea``
- mean_sea
-
- mean sea level
- ``mean_sea``
-
- No
-
-
* - ``medium_cloud_layer``
- medium_cloud_layer
-
- medium cloud layer
- ``mediumCloudLayer``
- hPa
- Yes
- bottom
- down
* - ``mixed_layer_depth_by_density``
- mixed_layer_depth_by_density
-
- mixed layer depth by density
- ``mixedLayerDepthByDensity``
- kg m-3
- No
-
- down
* - ``mixed_layer_parcel``
- mixed_layer_parcel
-
- mixed layer parcel
- ``mixedLayerParcel``
- Pa
Expand All @@ -255,47 +255,47 @@ Predefined level types
-
-
* - ``most_unstable_parcel``
- most_unstable_parcel
-
- most unstable parcel
- ``mostUnstableParcel``
-
- No
-
-
* - ``nominal_top_of_atmosphere``
- nominal_top_of_atmosphere
-
- nominal top of atmosphere
- ``nominalTopOfAtmosphere``
-
- No
-
-
* - ``ocean_model``
- ocean_model
-
- ocean model
- ``oceanModel``
-
- 1
- No
-
- down
* - ``ocean_model_layer``
- ocean_model_layer
-
- ocean model layer
- ``oceanModelLayer``
-
- 1
- Yes
- bottom
- down
* - ``ocean_surface``
- ocean_surface
-
- ocean surface
- ``ocean_surface``
-
- No
-
-
* - ``ocean_surface_to_bottom``
- ocean_surface_to_bottom
-
- ocean surface to bottom
- ``oceanSurfaceToBottom``
-
Expand All @@ -304,7 +304,7 @@ Predefined level types
-
* - ``potential_temperature``
- air_potential_temperature
- air potential temperature
- air_potential temperature
- ``pt``
- K
- No
Expand Down Expand Up @@ -335,39 +335,39 @@ Predefined level types
- top
- down
* - ``sea_ice_layer``
- sea_ice_layer
-
- sea ice layer
- ``seaIceLayer``
-
- 1
- Yes
- bottom
- down
* - ``snow``
-
- snow layer
- ``snow``
-
- 1
- Yes
- bottom
- down
* - ``snow_layer_over_ice_on_water``
- snow_layer_over_ice_on_water
-
- snow layer over ice on water
- ``snowLayerOverIceOnWater``
-
- No
-
-
* - ``soil_layer``
- soil_layer
-
- soil layer
- ``soilLayer``
-
- 1
- Yes
- bottom
- down
* - ``stratosphere``
- stratosphere
-
- stratosphere
- ``stratosphere``
-
Expand All @@ -391,31 +391,31 @@ Predefined level types
-
-
* - ``tropopause``
- tropopause
-
- tropopause
- ``tropopause``
-
- No
-
-
* - ``troposphere``
- troposphere
-
- troposphere
- ``troposphere``
-
- No
-
-
* - ``unknown``
- unknown
-
- unknown
- ``unknown``
-
- No
-
-
* - ``water_surface_to_isothermal_ocean_layer``
- water_surface_to_isothermal_ocean_layer
-
- water surface to isothermal ocean layer
- ``waterSurfaceToIsothermalOceanLayer``
-
Expand Down
Loading