Add from_polytope_reforecast() for hdate support across all encoders

covjsonkit/encoder/BoundingBox.py

@@ -117,8 +117,8 @@ def from_xarray(self, dataset):
         # Return the generated CoverageJSON
         return self.covjson
 
-    def from_polytope(self, result):
-
+    def from_polytope(self, result, date_key: str = "date") -> dict:
+        """Encode a polytope ``TensorIndexTree`` result into a MultiPoint (BoundingBox) CoverageJSON collection."""
         coords = {}
         mars_metadata = {}
         range_dict = {}
@@ -130,8 +130,7 @@ def from_polytope(self, result):
         fields["dates"] = []
         fields["levels"] = [0]
 
-        self.walk_tree(result, fields, coords, mars_metadata, range_dict)
-
+        self.walk_tree(result, fields, coords, mars_metadata, range_dict, date_key=date_key)
         logging.debug("The values returned from walking tree: %s", range_dict)  # noqa: E501
         logging.debug("The coordinates returned from walking tree: %s", coords)  # noqa: E501
 

covjsonkit/encoder/Circle.py

@@ -112,10 +112,10 @@ def from_xarray(self, dataset):
                     self.add_coverage(mars_metadata, coords, dv_dict)
 
         # Return the generated CoverageJSON
-        return self.covjsonå
-
-    def from_polytope(self, result):
+        return self.covjson
 
+    def from_polytope(self, result, date_key: str = "date") -> dict:
+        """Encode a polytope ``TensorIndexTree`` result into a MultiPoint (Circle) CoverageJSON collection."""
         coords = {}
         mars_metadata = {}
         range_dict = {}
@@ -127,7 +127,7 @@ def from_polytope(self, result):
         fields["dates"] = []
         fields["levels"] = [0]
 
-        self.walk_tree(result, fields, coords, mars_metadata, range_dict)
+        self.walk_tree(result, fields, coords, mars_metadata, range_dict, date_key=date_key)
 
         logging.debug("The values returned from walking tree: %s", range_dict)  # noqa: E501
         logging.debug("The coordinates returned from walking tree: %s", coords)  # noqa: E501

covjsonkit/encoder/Frame.py

@@ -114,8 +114,8 @@ def from_xarray(self, dataset):
         # Return the generated CoverageJSON
         return self.covjson
 
-    def from_polytope(self, result):
-
+    def from_polytope(self, result, date_key: str = "date") -> dict:
+        """Encode a polytope ``TensorIndexTree`` result into a MultiPoint (Frame) CoverageJSON collection."""
         coords = {}
         mars_metadata = {}
         range_dict = {}
@@ -127,7 +127,7 @@ def from_polytope(self, result):
         fields["dates"] = []
         fields["levels"] = [0]
 
-        self.walk_tree(result, fields, coords, mars_metadata, range_dict)
+        self.walk_tree(result, fields, coords, mars_metadata, range_dict, date_key=date_key)
 
         logging.debug("The values returned from walking tree: %s", range_dict)  # noqa: E501
         logging.debug("The coordinates returned from walking tree: %s", coords)  # noqa: E501

covjsonkit/encoder/Grid.py

@@ -120,8 +120,8 @@ def from_xarray(self, dataset):
         # Return the generated CoverageJSON
         return self.covjson
 
-    def from_polytope(self, result):
-
+    def from_polytope(self, result, date_key: str = "date") -> dict:
+        """Encode a polytope ``TensorIndexTree`` result into a Grid CoverageJSON collection."""
         coords = {}
         mars_metadata = {}
         range_dict = {}
@@ -133,8 +133,7 @@ def from_polytope(self, result):
         fields["dates"] = []
         fields["levels"] = [0]
 
-        self.walk_tree(result, fields, coords, mars_metadata, range_dict)
-
+        self.walk_tree(result, fields, coords, mars_metadata, range_dict, date_key=date_key)
         logging.debug("The values returned from walking tree: %s", range_dict)  # noqa: E501
         logging.debug("The coordinates returned from walking tree: %s", coords)  # noqa: E501
 

covjsonkit/encoder/Path.py

@@ -114,8 +114,8 @@ def from_xarray(self, dataset):
         # Return the generated CoverageJSON
         return self.covjson
 
-    def from_polytope(self, result):
-
+    def from_polytope(self, result, date_key: str = "date") -> dict:
+        """Encode a polytope ``TensorIndexTree`` result into a Trajectory (Path) CoverageJSON collection."""
         coords = {}
         mars_metadata = {}
         range_dict = {}
@@ -129,7 +129,7 @@ def from_polytope(self, result):
         fields["s"] = []
         fields["l"] = []
 
-        self.walk_tree(result, fields, coords, mars_metadata, range_dict)
+        self.walk_tree(result, fields, coords, mars_metadata, range_dict, date_key=date_key)
 
         if len(fields["l"]) == 0:
             fields["l"] = [0]

covjsonkit/encoder/Position.py

@@ -62,7 +62,7 @@ def from_xarray(self, datasets):
             datasets (Union[xarray.Dataset, List[xarray.Dataset]]): An xarray dataset or a list of xarray datasets.
 
         Returns:
-            dict: The CoverageJSON representation of the coverageCollection.
+            dict: The CoverageJSON representation of the coverage collection.
         """
         if not isinstance(datasets, list):
             datasets = [datasets]
@@ -123,13 +123,15 @@ def from_xarray(self, datasets):
 
         return self.covjson
 
-    def from_polytope(self, result):
-        """
-        Converts a Polytope result into an OGC CoverageJSON coverageCollection of type PointSeries
+    def from_polytope(self, result, date_key: str = "date") -> dict:
+        """Encode a polytope ``TensorIndexTree`` result into a PointSeries (Position) CoverageJSON collection.
+
         Args:
-            result (dict): The Polytope result containing the data to be converted.
+            result: The polytope ``TensorIndexTree`` containing the data to be converted.
+            date_key: Tree axis name to treat as the time dimension
+                (``"date"`` for forecasts, ``"hdate"`` for hindcast/reforecast).
         Returns:
-            dict: The CoverageJSON representation of the coverageCollection.
+            dict: The CoverageJSON representation of the coverage collection.
         """
         coords = {}
         mars_metadata = {}
@@ -144,7 +146,7 @@ def from_polytope(self, result):
 
         start = time.time()
         logging.debug("Tree walking starts at: %s", start)  # noqa: E501
-        self.walk_tree(result, fields, coords, mars_metadata, range_dict)
+        self.walk_tree(result, fields, coords, mars_metadata, range_dict, date_key=date_key)
         end = time.time()
         delta = end - start
         logging.debug("Tree walking ends at: %s", end)  # noqa: E501

covjsonkit/encoder/Shapefile.py

@@ -114,8 +114,8 @@ def from_xarray(self, dataset):
         # Return the generated CoverageJSON
         return self.covjson
 
-    def from_polytope(self, result):
-
+    def from_polytope(self, result, date_key: str = "date") -> dict:
+        """Encode a polytope ``TensorIndexTree`` result into a MultiPoint (Shapefile) CoverageJSON collection."""
         coords = {}
         mars_metadata = {}
         range_dict = {}
@@ -127,7 +127,7 @@ def from_polytope(self, result):
         fields["dates"] = []
         fields["levels"] = [0]
 
-        self.walk_tree(result, fields, coords, mars_metadata, range_dict)
+        self.walk_tree(result, fields, coords, mars_metadata, range_dict, date_key=date_key)
 
         logging.debug("The values returned from walking tree: %s", range_dict)  # noqa: E501
         logging.debug("The coordinates returned from walking tree: %s", coords)  # noqa: E501

covjsonkit/encoder/TimeSeries.py

@@ -62,7 +62,7 @@ def from_xarray(self, datasets):
             datasets (Union[xarray.Dataset, List[xarray.Dataset]]): An xarray dataset or a list of xarray datasets.
 
         Returns:
-            dict: The CoverageJSON representation of the coverageCollection.
+            dict: The CoverageJSON representation of the coverage collection.
         """
         if not isinstance(datasets, list):
             datasets = [datasets]
@@ -123,13 +123,15 @@ def from_xarray(self, datasets):
 
         return self.covjson
 
-    def from_polytope(self, result):
-        """
-        Converts a Polytope result into an OGC CoverageJSON coverageCollection of type PointSeries
+    def from_polytope(self, result, date_key: str = "date") -> dict:
+        """Encode a polytope ``TensorIndexTree`` result into a PointSeries CoverageJSON collection.
+
         Args:
-            result (dict): The Polytope result containing the data to be converted.
+            result: The polytope ``TensorIndexTree`` containing the data to be converted.
+            date_key: Tree axis name to treat as the time dimension
+                (``"date"`` for forecasts, ``"hdate"`` for hindcast/reforecast).
         Returns:
-            dict: The CoverageJSON representation of the coverageCollection.
+            dict: The CoverageJSON representation of the coverage collection.
         """
         coords = {}
         mars_metadata = {}
@@ -144,7 +146,7 @@ def from_polytope(self, result):
 
         start = time.time()
         logging.debug("Tree walking starts at: %s", start)  # noqa: E501
-        self.walk_tree(result, fields, coords, mars_metadata, range_dict)
+        self.walk_tree(result, fields, coords, mars_metadata, range_dict, date_key=date_key)
         end = time.time()
         delta = end - start
         logging.debug("Tree walking ends at: %s", end)  # noqa: E501

covjsonkit/encoder/VerticalProfile.py

@@ -121,7 +121,8 @@ def from_xarray(self, datasets):
 
         return self.covjson
 
-    def from_polytope(self, result):
+    def from_polytope(self, result, date_key: str = "date") -> dict:
+        """Encode a polytope ``TensorIndexTree`` result into a VerticalProfile CoverageJSON collection."""
         coords = {}
         mars_metadata = {}
         range_dict = {}
@@ -135,7 +136,7 @@ def from_polytope(self, result):
 
         start = time.time()
         logging.debug("Tree walking starts at: %s", start)  # noqa: E501
-        self.walk_tree(result, fields, coords, mars_metadata, range_dict)
+        self.walk_tree(result, fields, coords, mars_metadata, range_dict, date_key=date_key)
         end = time.time()
         delta = end - start
         logging.debug("Tree walking ends at: %s", end)  # noqa: E501

covjsonkit/encoder/Wkt.py

@@ -118,8 +118,8 @@ def from_xarray(self, dataset):
         # Return the generated CoverageJSON
         return self.covjson
 
-    def from_polytope(self, result):
-
+    def from_polytope(self, result, date_key: str = "date") -> dict:
+        """Encode a polytope ``TensorIndexTree`` result into a MultiPoint (Wkt/Polygon) CoverageJSON collection."""
         coords = {}
         mars_metadata = {}
         range_dict = {}
@@ -131,7 +131,7 @@ def from_polytope(self, result):
         fields["dates"] = []
         fields["levels"] = [0]
 
-        self.walk_tree(result, fields, coords, mars_metadata, range_dict)
+        self.walk_tree(result, fields, coords, mars_metadata, range_dict, date_key=date_key)
 
         logging.debug("The values returned from walking tree: %s", range_dict)  # noqa: E501
         logging.debug("The coordinates returned from walking tree: %s", coords)  # noqa: E501

covjsonkit/encoder/encoder.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 from abc import ABC, abstractmethod
+from typing import Any
 
 import orjson
 import pandas as pd
@@ -149,12 +152,29 @@ def get_json(self):
         # self.covjson = self.pydantic_coverage.model_dump_json(exclude_none=True, indent=4)
         return orjson.dumps(self.covjson)
 
-    def walk_tree(self, tree, fields, coords, mars_metadata, range_dict):
+    def walk_tree(
+        self,
+        tree,
+        fields: dict[str, Any],
+        coords: dict[str, dict[str, list]],
+        mars_metadata: dict[str, Any],
+        range_dict: dict[tuple, list],
+        date_key: str = "date",
+    ) -> None:
+        """Walk the polytope result tree, extracting data into fields, coords, and range_dict.
+
+        ``date_key`` controls which tree axis is treated as the time dimension
+        (e.g. ``"date"`` for forecasts, ``"hdate"`` for hindcast/reforecast data).
+        Any other axis with the default name falls through to ``mars_metadata``
+        instead.  Regardless of ``date_key``, values are always stored under
+        ``fields["dates"]``.
+        """
+
         def create_composite_key(date, level, num, para, s):
             return (date, level, num, para, s)
 
         def handle_non_leaf_node(child):
-            non_leaf_axes = ["latitude", "longitude", "param", "date"]
+            non_leaf_axes = ["latitude", "longitude", "param", date_key]
             if child.axis.name not in non_leaf_axes:
                 mars_metadata[child.axis.name] = child.values[0]
 
@@ -165,7 +185,7 @@ def handle_specific_axes(child):
                 return child.values
             if child.axis.name == "param":
                 return child.values
-            if child.axis.name in ["date", "time"]:
+            if child.axis.name in [date_key, "time"]:
                 dates = [f"{date}Z" for date in child.values]
                 mars_metadata["Forecast date"] = str(child.values[0])
                 for date in dates:
@@ -202,7 +222,7 @@ def append_composite_coords(dates, tree_values, lat, coords):
                             fields["l"].extend(result)
                     elif child.axis.name == "param":
                         fields["param"] = result
-                    elif child.axis.name in ["date", "time"]:
+                    elif child.axis.name in [date_key, "time"]:
                         fields["dates"].extend(result)
                     elif child.axis.name == "number":
                         fields["number"] = result
@@ -211,7 +231,7 @@ def append_composite_coords(dates, tree_values, lat, coords):
                         if "s" in fields:
                             fields["s"].extend(result)
 
-                self.walk_tree(child, fields, coords, mars_metadata, range_dict)
+                self.walk_tree(child, fields, coords, mars_metadata, range_dict, date_key=date_key)
         else:
             tree.values = [float(val) for val in tree.values]
             if all(val is None for val in tree.result):
@@ -529,5 +549,14 @@ def from_xarray(self, dataset):
         pass
 
     @abstractmethod
-    def from_polytope(self, result):
+    def from_polytope(self, result, date_key: str = "date") -> dict:
         pass
+
+    def from_polytope_reforecast(self, result) -> dict:
+        """Encode reforecast/reanalysis data that uses ``"hdate"`` as the time axis.
+
+        Delegates to :meth:`from_polytope` with ``date_key="hdate"``.
+        Each hdate produces a separate coverage; steps within a single
+        hdate become that coverage's t-axis values.
+        """
+        return self.from_polytope(result, date_key="hdate")

covjsonkit/version.py

@@ -1 +1 @@
-__version__ = "0.2.15"
+__version__ = "0.2.16"

pyproject.toml

@@ -8,7 +8,7 @@ markers = ["data: uses test data (deselect with '-m \"not data\"')",]
 
 [project]
 name = "covjsonkit"
-version = "0.2.15"
+version = "0.2.16"
 dependencies = [
     "pandas<3",
     "orjson",
@@ -23,3 +23,7 @@ geo = [
     "rasterio",
     "shapely",
 ]
+tests = [
+    "pytest",
+    "polytope-python",
+]

requirements.txt

@@ -5,3 +5,4 @@ covjson-pydantic
 conflator
 scipy
 pre-commit
+polytope-python