rashdf 0.10.0__tar.gz → 0.11.0__tar.gz

{rashdf-0.10.0 → rashdf-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rashdf
-Version: 0.10.0
+Version: 0.11.0
 Summary: Read data from HEC-RAS HDF files.
 Project-URL: repository, https://github.com/fema-ffrd/rashdf
 Classifier: Development Status :: 4 - Beta
@@ -17,6 +17,7 @@ Requires-Dist: h5py
 Requires-Dist: geopandas<2.0,>=1.0
 Requires-Dist: pyarrow
 Requires-Dist: xarray<=2025.4.0
+Requires-Dist: pandas<3.0,>=2.0
 Provides-Extra: dev
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
@@ -29,6 +30,7 @@ Requires-Dist: fsspec; extra == "dev"
 Requires-Dist: s3fs; extra == "dev"
 Requires-Dist: fiona==1.9.6; extra == "dev"
 Requires-Dist: numcodecs<0.16; extra == "dev"
+Requires-Dist: rioxarray; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"

{rashdf-0.10.0 → rashdf-0.11.0}/pyproject.toml

@@ -12,8 +12,14 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
 ]
-version = "0.10.0"
-dependencies = ["h5py", "geopandas>=1.0,<2.0", "pyarrow", "xarray<=2025.4.0"]
+version = "0.11.0"
+dependencies = [
+    "h5py",
+    "geopandas>=1.0,<2.0",
+    "pyarrow",
+    "xarray<=2025.4.0",
+    "pandas>=2.0,<3.0"
+]
 
 [project.optional-dependencies]
 dev = [
@@ -27,7 +33,8 @@ dev = [
     "fsspec",
     "s3fs",
     "fiona==1.9.6",
-    "numcodecs<0.16"
+    "numcodecs<0.16",
+    "rioxarray",
 ]
 docs = ["sphinx", "numpydoc", "sphinx_rtd_theme"]
 

{rashdf-0.10.0 → rashdf-0.11.0}/src/rashdf/geom.py

@@ -150,13 +150,13 @@ class RasGeomHdf(RasHdf):
             ][()][:, 0]
             face_id_lists = list(
                 np.vectorize(
-                    lambda cell_id,
-                    cell_face_values=cell_face_values,
-                    cell_face_info=cell_face_info: str(
-                        cell_face_values[
-                            cell_face_info[cell_id][0] : cell_face_info[cell_id][0]
-                            + cell_face_info[cell_id][1]
-                        ]
+                    lambda cell_id, cell_face_values=cell_face_values, cell_face_info=cell_face_info: (
+                        str(
+                            cell_face_values[
+                                cell_face_info[cell_id][0] : cell_face_info[cell_id][0]
+                                + cell_face_info[cell_id][1]
+                            ]
+                        )
                     )
                 )(cell_ids)
             )

{rashdf-0.10.0 → rashdf-0.11.0}/src/rashdf/plan.py

@@ -4,6 +4,7 @@ from .geom import RasGeomHdf
 from .utils import (
     df_datetimes_to_str,
     ras_timesteps_to_datetimes,
+    parse_ras_datetime,
     parse_ras_datetime_ms,
     deprecated,
     convert_ras_hdf_value,
@@ -18,7 +19,7 @@ import xarray as xr
 
 from datetime import datetime
 from enum import Enum
-from typing import Dict, List, Optional, Tuple, Union
+from typing import Dict, List, Optional, Tuple, Union, Sequence
 
 # Shared constant
 WATER_SURFACE = "Water Surface"
@@ -1927,3 +1928,65 @@ class RasPlanHdf(RasGeomHdf):
         }
 
         return wide_df
+
+    def gridded_precip(
+        self,
+        timestamps: Optional[Union[Sequence[datetime], pd.Series]] = None,
+        precip_attrs: Optional[Dict] = None,
+    ) -> xr.DataArray:
+        """Return precipitation timeseries input data from a HEC-RAS HDF plan file.
+
+        Requires the 'rioxarray' package.
+
+        Parameters
+        ----------
+        timestamps : Optional[Union[Sequence[datetime], pd.Series]], optional
+            Optional sequence of timestamps to use for the time coordinate. If None, timestamps will be read from the HDF file.
+        precip_attrs : Optional[Dict], optional
+            Optional dictionary of precipitation attributes. If None, attributes will be read from the HDF file.
+
+        Returns
+        -------
+        xr.DataArray
+            An xarray DataArray with precipitation timeseries input data.
+        """
+        import rioxarray
+
+        precip_group = self[self.PRECIP_PATH]
+        precip_values: h5py.Dataset = precip_group["Values"]
+        if timestamps is None:
+            ds_timestamps: h5py.Dataset = precip_group["Timestamp"]
+            timestamps = pd.Series(ds_timestamps.asstr()[:]).map(parse_ras_datetime)
+        if precip_attrs is None:
+            precip_attrs = self.get_meteorology_precip_attrs()
+        crs = precip_attrs.get("Projection")
+        rows = precip_attrs.get("Raster Rows")
+        cols = precip_attrs.get("Raster Cols")
+        top = precip_attrs.get("Raster Top")
+        left = precip_attrs.get("Raster Left")
+        cell_size = precip_attrs.get("Raster Cellsize")
+        if not all([rows, cols, top, left, cell_size]):
+            raise RasPlanHdfError(
+                "Precipitation raster metadata is missing or incomplete."
+            )
+
+        precip_values: np.ndarray = precip_values[:]
+        precip_values = precip_values.reshape(precip_values.shape[0], rows, cols)
+        x_coords = left + np.arange(cols) * cell_size + cell_size / 2
+        y_coords = top - np.arange(rows) * cell_size - cell_size / 2
+        precip = xr.DataArray(
+            precip_values,
+            name="Precipitation",
+            dims=["time", "y", "x"],
+            coords={
+                "time": timestamps,
+                "y": y_coords,
+                "x": x_coords,
+            },
+            attrs={
+                "units": precip_attrs.get("Units"),
+                "hdf_path": f"{self.PRECIP_PATH}/Values",
+            },
+        )
+        precip = precip.rio.write_crs(crs)
+        return precip

{rashdf-0.10.0 → rashdf-0.11.0}/src/rashdf.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rashdf
-Version: 0.10.0
+Version: 0.11.0
 Summary: Read data from HEC-RAS HDF files.
 Project-URL: repository, https://github.com/fema-ffrd/rashdf
 Classifier: Development Status :: 4 - Beta
@@ -17,6 +17,7 @@ Requires-Dist: h5py
 Requires-Dist: geopandas<2.0,>=1.0
 Requires-Dist: pyarrow
 Requires-Dist: xarray<=2025.4.0
+Requires-Dist: pandas<3.0,>=2.0
 Provides-Extra: dev
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
@@ -29,6 +30,7 @@ Requires-Dist: fsspec; extra == "dev"
 Requires-Dist: s3fs; extra == "dev"
 Requires-Dist: fiona==1.9.6; extra == "dev"
 Requires-Dist: numcodecs<0.16; extra == "dev"
+Requires-Dist: rioxarray; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"

{rashdf-0.10.0 → rashdf-0.11.0}/src/rashdf.egg-info/requires.txt

@@ -2,6 +2,7 @@ h5py
 geopandas<2.0,>=1.0
 pyarrow
 xarray<=2025.4.0
+pandas<3.0,>=2.0
 
 [dev]
 pre-commit
@@ -15,6 +16,7 @@ fsspec
 s3fs
 fiona==1.9.6
 numcodecs<0.16
+rioxarray
 
 [docs]
 sphinx

{rashdf-0.10.0 → rashdf-0.11.0}/tests/test_plan.py

@@ -834,3 +834,23 @@ def test_bc_lines_flow(tmp_path: Path):
         dtype={"Flow": np.float32},
     )
     assert_frame_equal(df_bcline7, valid_df, check_dtype=False)
+
+
+def test_gridded_precip():
+    plan_hdf = RasPlanHdf(TEST_DATA / "ras/ElkMiddle.gridded-precip.p01.hdf")
+    precip = plan_hdf.gridded_precip()
+    assert precip.shape == (24, 160, 110)
+    assert (
+        precip.attrs["units"]
+        == plan_hdf["/Event Conditions/Meteorology/Precipitation"]
+        .attrs["Units"]
+        .decode()
+    )
+
+
+def test_gridded_precip_bad_precip_attrs():
+    plan_hdf = RasPlanHdf(TEST_DATA / "ras/ElkMiddle.gridded-precip.p01.hdf")
+    precip_attrs = plan_hdf.get_meteorology_precip_attrs()
+    precip_attrs.pop("Raster Rows")
+    with pytest.raises(RasPlanHdfError):
+        plan_hdf.gridded_precip(precip_attrs=precip_attrs)