Version 1.0.0 Release Candidate Updates

Version 1.0.0rc3

• Added option “bolton43” to compute the equivalent potential temperature using equation (43) from [Bolton1980] (#128). See:

  • ept_from_dewpoint()

  • ept_from_specific_humidity()

Version 1.0.0rc2

• Added high level fieldlist interface to earthkit.meteo.wind module and also to the earthkit.meteo.thermo.potential_temperature() method in earthkit.meteo.thermo (#147).

Version 1.0.0rc1

Deprecations

• pressure_at_model_levels() is deprecated

• relative_geopotential_thickness() is deprecated

• pressure_at_height_levels() is deprecated

Removed

The following functions have been removed:

• earthkit.meteo.thermo.kelvin_to_celsius()

• earthkit.meteo.thermo.celsius_to_kelvin()

They can be both replaced by using the newly added T_C2K (273.15 K) constant.

High level interface

Added a high-level interface to most of the functions to support both array-based and Xarray-based inputs (#119). This offers automatic dispatching to the appropriate implementation based on the input type. This allows users to use the same function names and parameters regardless of the input type, while still benefiting from the optimized implementations for each type.

from earthkit.meteo.wind import wind_speed

# For array-based inputs
speed = wind_speed(u_array, v_array)

# For Xarray-based inputs
speed = wind_speed(u_xarray, v_xarray)

The actual implementations are now available in the array and xarray submodules and can also be directly accessed bypassing the high level dispatch mechanism.

from earthkit.meteo.wind.array import wind_speed as array_wind_speed
from earthkit.meteo.wind.xarray import wind_speed as xarray_wind_speed

# For array-based inputs
speed = array_wind_speed(u_array, v_array)

# For Xarray-based inputs
speed = xarray_wind_speed(u_xarray, v_xarray)

Array-based vertical coordinate functions

Added the following array-based functions to earthkit.meteo.vertical.array to compute vertical coordinate parameters:

• hybrid_level_parameters()

• pressure_on_hybrid_levels()

• relative_geopotential_thickness_on_hybrid_levels_from_alpha_delta()

• relative_geopotential_thickness_on_hybrid_levels()

• geopotential_on_hybrid_levels()

• height_on_hybrid_levels()

See the notebook examples:

• /how-tos/hybrid_levels.ipynb

Array-based vertical interpolations

Added the following array-based vertical interpolation functions to earthkit.meteo.vertical.array:

• interpolate_hybrid_to_pressure_levels()

• interpolate_hybrid_to_height_levels()

• interpolate_pressure_to_height_levels()

• interpolate_monotonic()

See the notebook examples:

• /how-tos/interpolate_hybrid_to_hl.ipynb

• /how-tos/interpolate_hybrid_to_pl.ipynb

• /how-tos/interpolate_pl_to_hl.ipynb

• /how-tos/interpolate_pl_to_pl.ipynb

Xarray-based vertical interpolation functions

Added the following Xarray-based interpolation functions to earthkit.meteo.vertical.xarray:

• interpolate_monotonic()

• interpolate_to_pressure_levels()

• interpolate_sleve_to_coord_levels()

• interpolate_sleve_to_theta_levels()

Regimes

Added new submodule earthkit.meteo.regimes with classes to define a weather regime classification based on patterns and functions to project anomaly fields onto these patterns to compute a regime index, following the approach of Michel and Rivière (2011).

See the notebook example: /how-tos/seven_weather_regimes.ipynb