Merge pull request #43 from ecmwf/feature/merge-main-into-develop

Feature/merge main into develop

docs/conf.py

@@ -70,9 +70,9 @@
         "earthkit-data",
         "https://earthkit-data.readthedocs.io/en/latest/",
     ),
-    "earthkit-maps": (
-        "earthkit-maps",
-        "https://earthkit-maps.readthedocs.io/en/latest/",
+    "earthkit-plots": (
+        "earthkit-plots",
+        "https://earthkit-plots.readthedocs.io/en/latest/",
     ),
     "fieldlist": (
         "fieldlist",

docs/examples/numpy_arrays.ipynb

@@ -104,7 +104,7 @@
    "id": "b91238ec-13b4-40c7-88c3-b703f311743d",
    "metadata": {},
    "source": [
-    "Define some helper methods for plotting. This will be done by earthkit-maps in the future."
+    "Define some helper methods for plotting."
    ]
   },
   {

docs/gridspec.rst

@@ -54,3 +54,37 @@ Example:
 .. code-block::
 
     {"grid": [1, 1]}
+
+
+
+HEALPix nested grid
+------------------------------------------
+
+The ``grid`` format is::
+
+    HXXX
+
+The ``ordering`` must be set to ``"nested"``. For details about this grid, see `here  <https://en.wikipedia.org/wiki/HEALPix>`_.
+
+Example:
+
+.. code-block::
+
+    {"grid": "H512", "ordering": "nested"}
+
+
+HEALPix ring grid
+------------------------------------------
+
+The ``grid`` format is::
+
+    HXXX
+
+The ``ordering`` can be omitted or set to ``"ring"``.  For details about this grid, see `here  <https://en.wikipedia.org/wiki/HEALPix>`_.
+
+Example:
+
+.. code-block::
+
+    {"grid": "H512", "ordering": "ring"}
+    {"grid": "H512"}

docs/release_notes/version_0.3_updates.rst

@@ -1,6 +1,13 @@
 Version 0.3 Updates
 /////////////////////////
 
+Version 0.3.4
+===============
+
+Fixes
+++++++++++++++++
+- fixed issue when the "grid" value in a gridspec could not be specified as a tuple
+
 
 Version 0.3.3
 ===============
@@ -33,7 +40,7 @@ New features
 ++++++++++++++++
 - restructured and regenerated matrix inventory
 - allow using the ``method`` keyword in :func:`interpolate` to specify the interpolation method
-- allow using earthkit-data GRIB :xref:`fieldlist` in :func:`interpolate` as input data. This only works when  the output grid is regular a latitude-longitude grid. This feature requires :xref:`earthkit-data` >= 0.6.0
+- allow using earthkit-data GRIB :xref:`fieldlist` in :func:`interpolate` as input data. This only works when  the output grid is a regular latitude-longitude grid. This feature requires :xref:`earthkit-data` >= 0.6.0
 - added notebook examples:
 
    - :ref:`/examples/healpix_fieldlist.ipynb`

src/earthkit/regrid/gridspec.py

@@ -51,10 +51,18 @@ def __init__(self, gs):
         self._global_ns = None
         super().__init__(gs)
 
+    @staticmethod
+    def _normalise(d):
+        for k, v in d.items():
+            if isinstance(v, tuple):
+                d[k] = list(v)
+
     @staticmethod
     def from_dict(d):
         gs = dict(GridSpec.DEFAULTS)
         gs.update(d)
+        GridSpec._normalise(gs)
+
         t_name, t = GridSpec._infer_spec_type(gs)
         if t is None:
             raise ValueError(f"Unsupported gridspec={d}")

src/earthkit/regrid/sphinxext/generate_inventory_rst.py

@@ -23,7 +23,12 @@
 def to_str(gs):
     if isinstance(gs, str):
         return gs
-    return {"grid": gs["grid"]}
+
+    grid = gs["grid"]
+    if isinstance(grid, str) and grid.startswith("H"):
+        return {"grid": gs["grid"], "ordering": gs["ordering"]}
+    else:
+        return {"grid": gs["grid"]}
 
 
 def make_gs_block(source, target):

tests/test_gridspec.py

@@ -82,6 +82,7 @@
         ),
         ({"grid": "H128"}, {"grid": [1, 1]}),
         ({"grid": "H128", "ordering": "ring"}, {"grid": [1, 1]}),
+        ({"grid": (5, 5)}, {"grid": (10, 10)}),
     ],
 )
 def test_gridspec_ok(gs_in, gs_out):