Array based vertical interpolation

docs/references.rst

@@ -18,7 +18,7 @@ Bolton, D., (1980). The computation of equivalent potential temperature. Mon. We
 
 .. [DaviesJones1983]
 
-Davies-Jones, R. P., (1983). An accurate theoretical approximation for adiabatic condensation temperature. Mon. Wea. Rev., 111 , 1119–1121.
+Davies-Jones, R. P., (1983). An accurate theoretical approximation for adiabatic condensation temperature. Mon. Wea. Rev., 111 , 1119-1121.
 
 
 .. [DaviesJones2008]

docs/release_notes/deprecation.rst

@@ -0,0 +1,73 @@
+Deprecations
+=============
+
+
+.. _deprecated-0.7.0:
+
+Version 0.7.0
+-----------------
+
+.. _deprecated-hybrid-pressure-at-model-levels:
+
+:func:`pressure_at_model_levels` is deprecated
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+It is replaced by the more generic :func:`pressure_on_hybrid_levels`. The old method is still available for backward compatibility but will be removed in a future release.
+
+
+.. list-table::
+   :header-rows: 0
+
+   * - Deprecated code
+   * -
+
+        .. literalinclude:: include/deprec_hybrid_pressure.py
+
+   * - New code
+   * -
+
+        .. literalinclude:: include/migrated_hybrid_pressure.py
+
+
+.. _deprecated-hybrid-relative-geopotential-thickness:
+
+:func:`relative_geopotential_thickness` is deprecated
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+It is replaced by the more generic :func:`relative_geopotential_thickness_on_hybrid_levels`. The old method is still available for backward compatibility but will be removed in a future release.
+
+
+.. list-table::
+   :header-rows: 0
+
+   * - Deprecated code
+   * -
+
+        .. literalinclude:: include/deprec_hybrid_geopotential_thickness.py
+
+   * - New code
+   * -
+
+        .. literalinclude:: include/migrated_hybrid_geopotential_thickness.py
+
+
+.. _deprecated-hybrid-pressure-at-height-levels:
+
+:func:`pressure_at_height_levels` is deprecated
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+It is replaced by the combined usage of :func:`pressure_on_hybrid_levels` and :func:`interpolate_hybrid_to_height_levels`. The old method is still available for backward compatibility but will be removed in a future release.
+
+
+.. list-table::
+   :header-rows: 0
+
+   * - Deprecated code
+   * -
+
+        .. literalinclude:: include/deprec_hybrid_pressure_at_height_levels.py
+
+   * - New code
+   * -
+
+        .. literalinclude:: include/migrated_hybrid_pressure_at_height_levels.py

docs/release_notes/include/deprec_hybrid_geopotential_thickness.py

@@ -0,0 +1,21 @@
+import numpy as np
+
+import earthkit.meteo.vertical as vertical
+from earthkit.meteo.utils.testing import hybrid_level_test_data
+
+# get hybrid (IFS model) level definition
+A, B = vertical.hybrid_level_parameters(137, model="ifs")
+
+# define surface pressures
+sp = np.array([100000.0, 90000.0])
+
+# compute alpha and delta
+_, _, delta, alpha = vertical.pressure_at_model_levels(A, B, sp, alpha_top="ifs")
+
+# get temperature and specific humidity profiles on hybrid levels (example data)
+DATA = hybrid_level_test_data()
+t = np.array(DATA.t)
+q = np.array(DATA.q)
+
+# compute the relative geopotential thickness
+z_thickness = vertical.relative_geopotential_thickness(alpha, delta, t, q)

docs/release_notes/include/deprec_hybrid_pressure.py

@@ -0,0 +1,11 @@
+import numpy as np
+
+import earthkit.meteo.vertical as vertical
+
+# get hybrid (IFS model) level definition
+A, B = vertical.hybrid_level_parameters(137, model="ifs")
+
+# define surface pressures
+sp = np.array([100000.0, 90000.0])
+
+p_full, p_half, delta, alpha = vertical.pressure_at_model_levels(A, B, sp, alpha_top="ifs")

docs/release_notes/include/deprec_hybrid_pressure_at_height_levels.py

@@ -0,0 +1,20 @@
+import numpy as np
+
+import earthkit.meteo.vertical as vertical
+from earthkit.meteo.utils.testing import hybrid_level_test_data
+
+# get hybrid (IFS model) level definition
+A, B = vertical.hybrid_level_parameters(137, model="ifs")
+
+# define surface pressures
+sp = np.array([100000.0, 90000.0])
+
+# get temperature and specific humidity profiles on hybrid levels (example data)
+DATA = hybrid_level_test_data()
+t = np.array(DATA.t)
+q = np.array(DATA.q)
+
+# compute the pressure on geopotential height levels above the
+# ground using linear interpolation
+h_target = 10.0
+p = vertical.pressure_at_height_levels(h_target, t, q, sp, A, B, alpha_top="ifs")

docs/release_notes/include/migrated_hybrid_geopotential_thickness.py

@@ -0,0 +1,18 @@
+import numpy as np
+
+import earthkit.meteo.vertical as vertical
+from earthkit.meteo.utils.testing import hybrid_level_test_data
+
+# get hybrid (IFS model) level definition
+A, B = vertical.hybrid_level_parameters(137, model="ifs")
+
+# define surface pressures
+sp = np.array([100000.0, 90000.0])
+
+# get temperature and specific humidity profiles on hybrid levels (example data)
+DATA = hybrid_level_test_data()
+t = DATA.t
+q = DATA.q
+
+# compute the relative geopotential thickness
+z_thickness = vertical.relative_geopotential_thickness_on_hybrid_levels(t, q, A, B, sp, alpha_top="ifs")

docs/release_notes/include/migrated_hybrid_pressure.py

@@ -0,0 +1,13 @@
+import numpy as np
+
+import earthkit.meteo.vertical as vertical
+
+# get hybrid (IFS model) level definition
+A, B = vertical.hybrid_level_parameters(137, model="ifs")
+
+# define surface pressures
+sp = np.array([100000.0, 90000.0])
+
+p_full, p_half, delta, alpha = vertical.pressure_on_hybrid_levels(
+    A, B, sp, alpha_top="ifs", output=["full", "half", "delta", "alpha"]
+)

docs/release_notes/include/migrated_hybrid_pressure_at_height_levels.py

@@ -0,0 +1,36 @@
+import numpy as np
+
+import earthkit.meteo.vertical as vertical
+from earthkit.meteo.utils.testing import hybrid_level_test_data
+
+# get hybrid (IFS model) level definition
+A, B = vertical.hybrid_level_parameters(137, model="ifs")
+
+# define surface pressures
+sp = np.array([100000.0, 90000.0])
+
+# compute the pressure on full hybrid levels
+p_full = vertical.pressure_on_hybrid_levels(A, B, sp, alpha_top="ifs", output="full")
+
+# get temperature and specific humidity profiles on hybrid levels (example data)
+DATA = hybrid_level_test_data()
+t = np.array(DATA.t)
+q = np.array(DATA.q)
+
+# interpolate the pressure to geopotential height levels above the ground
+# using linear interpolation
+target_h = [10.0]
+p_h = vertical.interpolate_hybrid_to_height_levels(
+    p_full,
+    t,
+    q,
+    0,
+    A,
+    B,
+    sp,
+    target_h,
+    h_type="geopotential",
+    h_reference="ground",
+    interpolation="linear",
+    alpha_top="ifs",
+)

docs/release_notes/index.rst

@@ -4,6 +4,7 @@ Release notes
 .. toctree::
     :maxdepth: 1
 
+    version_0.7_updates
     version_0.6_updates
     version_0.5_updates
     version_0.4_updates

docs/release_notes/version_0.7_updates.rst

@@ -0,0 +1,24 @@
+Version 0.7 Updates
+/////////////////////////
+
+
+Version 0.7.0
+===============
+
+Deprecations
++++++++++++++++++++
+
+- :ref:`deprecated-hybrid-pressure-at-model-levels`
+- :ref:`deprecated-hybrid-relative-geopotential-thickness`
+- :ref:`deprecated-hybrid-pressure-at-height-levels`
+
+Vertical coordinate functions
+-------------------------------
+
+TODO: add docs
+
+
+Vertical interpolations
+------------------------
+
+TODO: add docs

pyproject.toml

@@ -27,6 +27,7 @@ classifiers = [
 ]
 dynamic = [ "version" ]
 dependencies = [
+  "deprecation",
   "earthkit-utils>=0.0.1",
   "numpy",
 ]

src/earthkit/meteo/utils/testing.py

@@ -10,16 +10,40 @@
 # A collection of functions to support pytest testing
 
 import os
+import sys
+from importlib import import_module
 
-from earthkit.utils.testing import get_array_backend
+# from earthkit.utils.testing import get_array_backend
 
-ARRAY_BACKENDS = get_array_backend(["numpy", "torch", "cupy"], raise_on_missing=False)
-NUMPY_BACKEND = get_array_backend("numpy")
+# ARRAY_BACKENDS = get_array_backend(["numpy", "torch", "cupy"], raise_on_missing=False)
+# NUMPY_BACKEND = get_array_backend("numpy")
 
-ROOT_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(__file__))))
-if not os.path.exists(os.path.join(ROOT_DIR, "tests")):
-    ROOT_DIR = "./"
+_ROOT_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(__file__)))))
+if not os.path.exists(os.path.join(_ROOT_DIR, "tests")):
+    _ROOT_DIR = "./"
 
 
-def test_data_path(filename: str) -> str:
-    return os.path.join(ROOT_DIR, filename)
+def earthkit_file(*args) -> str:
+    return os.path.join(_ROOT_DIR, *args)
+
+
+def modules_installed(*modules) -> bool:
+    for module in modules:
+        try:
+            import_module(module)
+        except (ImportError, RuntimeError, SyntaxError):
+            return False
+    return True
+
+
+def hybrid_level_test_data():
+    """Import hybrid level test data from tests/vertical/_hybrid_core_data.py"""
+    name = "_hybrid_core_data"
+    path = earthkit_file("tests/vertical")
+    if path not in sys.path:
+        sys.path.insert(0, path)
+
+    return import_module(name)
+
+
+NO_XARRAY = not modules_installed("xarray")

src/earthkit/meteo/vertical/array/__init__.py

@@ -11,4 +11,5 @@
 Vertical computation functions operating on numpy arrays.
 """
 
+from .hybrid import *  # noqa
 from .vertical import *  # noqa