rashdf 0.7.2__py3-none-any.whl → 0.8.1__py3-none-any.whl

cli.py

@@ -21,6 +21,7 @@ COMMANDS = [
     "mesh_cell_faces",
     "refinement_regions",
     "bc_lines",
+    "ic_points",
     "breaklines",
     "reference_lines",
     "reference_points",

rashdf/geom.py

@@ -17,6 +17,8 @@ from shapely import (
 )
 
 from typing import Dict, List, Optional, Union
+from warnings import warn
+from pathlib import Path
 
 
 from .base import RasHdf
@@ -29,7 +31,7 @@ from .utils import (
 
 
 class RasGeomHdfError(Exception):
-    """HEC-RAS Plan HDF error class."""
+    """HEC-RAS Geometry HDF error class."""
 
     pass
 
@@ -41,7 +43,9 @@ class RasGeomHdf(RasHdf):
     GEOM_STRUCTURES_PATH = f"{GEOM_PATH}/Structures"
     FLOW_AREA_2D_PATH = f"{GEOM_PATH}/2D Flow Areas"
     BC_LINES_PATH = f"{GEOM_PATH}/Boundary Condition Lines"
+    IC_POINTS_PATH = f"{GEOM_PATH}/IC Points"
     BREAKLINES_PATH = f"{GEOM_PATH}/2D Flow Area Break Lines"
+    REFINEMENT_REGIONS_PATH = f"{GEOM_PATH}/2D Flow Area Refinement Regions"
     REFERENCE_LINES_PATH = f"{GEOM_PATH}/Reference Lines"
     REFERENCE_POINTS_PATH = f"{GEOM_PATH}/Reference Points"
     CROSS_SECTIONS = f"{GEOM_PATH}/Cross Sections"
@@ -294,19 +298,28 @@ class RasGeomHdf(RasHdf):
         polyline_points = self[polyline_points_path][()]
 
         geoms = []
-        for pnt_start, pnt_cnt, part_start, part_cnt in polyline_info:
-            points = polyline_points[pnt_start : pnt_start + pnt_cnt]
-            if part_cnt == 1:
-                geoms.append(LineString(points))
-            else:
-                parts = polyline_parts[part_start : part_start + part_cnt]
-                geoms.append(
-                    MultiLineString(
-                        list(
-                            points[part_pnt_start : part_pnt_start + part_pnt_cnt]
-                            for part_pnt_start, part_pnt_cnt in parts
+        for i, (pnt_start, pnt_cnt, part_start, part_cnt) in enumerate(polyline_info):
+            try:
+                points = polyline_points[pnt_start : pnt_start + pnt_cnt]
+                if part_cnt == 1:
+                    geoms.append(LineString(points))
+                else:  # pragma: no cover | TODO: add test coverage for this
+                    parts = polyline_parts[part_start : part_start + part_cnt]
+                    geoms.append(
+                        MultiLineString(
+                            list(
+                                points[part_pnt_start : part_pnt_start + part_pnt_cnt]
+                                for part_pnt_start, part_pnt_cnt in parts
+                            )
                         )
                     )
+            except (
+                Exception
+            ) as e:  # pragma: no cover | TODO: add test coverage for this
+                geoms.append(None)
+                warn(
+                    f"Feature ID {i} within '{Path(path).name}' layer set to null due to invalid geometry. {e}",
+                    UserWarning,
                 )
         return geoms
 
@@ -369,25 +382,38 @@ class RasGeomHdf(RasHdf):
         GeoDataFrame
             A GeoDataFrame containing the 2D mesh area refinement regions if they exist.
         """
-        if "/Geometry/2D Flow Area Refinement Regions" not in self:
+        if self.REFINEMENT_REGIONS_PATH not in self:
             return GeoDataFrame()
-        rr_data = self["/Geometry/2D Flow Area Refinement Regions"]
+        rr_data = self[self.REFINEMENT_REGIONS_PATH]
         rr_ids = range(rr_data["Attributes"][()].shape[0])
         names = np.vectorize(convert_ras_hdf_string)(rr_data["Attributes"][()]["Name"])
         geoms = list()
-        for pnt_start, pnt_cnt, part_start, part_cnt in rr_data["Polygon Info"][()]:
-            points = rr_data["Polygon Points"][()][pnt_start : pnt_start + pnt_cnt]
-            if part_cnt == 1:
-                geoms.append(Polygon(points))
-            else:
-                parts = rr_data["Polygon Parts"][()][part_start : part_start + part_cnt]
-                geoms.append(
-                    MultiPolygon(
-                        list(
-                            points[part_pnt_start : part_pnt_start + part_pnt_cnt]
-                            for part_pnt_start, part_pnt_cnt in parts
+        for i, (pnt_start, pnt_cnt, part_start, part_cnt) in enumerate(
+            rr_data["Polygon Info"][()]
+        ):
+            try:
+                points = rr_data["Polygon Points"][()][pnt_start : pnt_start + pnt_cnt]
+                if part_cnt == 1:
+                    geoms.append(Polygon(points))
+                else:  # pragma: no cover | TODO: add test coverage for this
+                    parts = rr_data["Polygon Parts"][()][
+                        part_start : part_start + part_cnt
+                    ]
+                    geoms.append(
+                        MultiPolygon(
+                            list(
+                                points[part_pnt_start : part_pnt_start + part_pnt_cnt]
+                                for part_pnt_start, part_pnt_cnt in parts
+                            )
                         )
                     )
+            except (
+                Exception
+            ) as e:  # pragma: no cover | TODO: add test coverage for this
+                geoms.append(None)
+                warn(
+                    f"Feature ID {i} within '{Path(self.REFINEMENT_REGIONS_PATH).name}' layer set to null due to invalid geometry. {e}",
+                    UserWarning,
                 )
         return GeoDataFrame(
             {"rr_id": rr_ids, "name": names, "geometry": geoms},
@@ -408,7 +434,10 @@ class RasGeomHdf(RasHdf):
         GeoDataFrame
             A GeoDataFrame containing the model structures if they exist.
         """
-        if self.GEOM_STRUCTURES_PATH not in self:
+        if (
+            self.GEOM_STRUCTURES_PATH not in self
+            or f"{self.GEOM_STRUCTURES_PATH}/Attributes" not in self
+        ):
             return GeoDataFrame()
         struct_data = self[self.GEOM_STRUCTURES_PATH]
         v_conv_val = np.vectorize(convert_ras_hdf_value)
@@ -438,7 +467,32 @@ class RasGeomHdf(RasHdf):
         raise NotImplementedError
 
     def ic_points(self) -> GeoDataFrame:  # noqa D102
-        raise NotImplementedError
+        """Return initial conditions points.
+
+        Returns
+        -------
+        GeoDataFrame
+            A GeoDataFrame containing the initial condition points if they exist.
+        """
+        if self.IC_POINTS_PATH not in self:
+            return GeoDataFrame()
+        ic_data = self[self.IC_POINTS_PATH]
+        v_conv_str = np.vectorize(convert_ras_hdf_string)
+        names = v_conv_str(ic_data["Attributes"][()]["Name"])
+        mesh_names = v_conv_str(ic_data["Attributes"][()]["SA/2D"])
+        cell_ids = ic_data["Attributes"][()]["Cell Index"]
+        points = ic_data["Points"][()]
+        return GeoDataFrame(
+            {
+                "icpt_id": range(len(names)),
+                "icpt_name": names,
+                "mesh_name": mesh_names,
+                "cell_id": cell_ids,
+                "geometry": list(map(Point, points)),
+            },
+            geometry="geometry",
+            crs=self.projection(),
+        )
 
     def _reference_lines_points_names(
         self, reftype: str = "lines", mesh_name: Optional[str] = None

rashdf/plan.py

@@ -168,6 +168,7 @@ class RasPlanHdf(RasGeomHdf):
     UNSTEADY_TIME_SERIES_PATH = f"{BASE_OUTPUT_PATH}/Unsteady Time Series"
     REFERENCE_LINES_OUTPUT_PATH = f"{UNSTEADY_TIME_SERIES_PATH}/Reference Lines"
     REFERENCE_POINTS_OUTPUT_PATH = f"{UNSTEADY_TIME_SERIES_PATH}/Reference Points"
+    BOUNDARY_CONDITIONS_OUTPUT_PATH = f"{UNSTEADY_TIME_SERIES_PATH}/Boundary Conditions"
     OBS_FLOW_OUTPUT_PATH = f"{OBS_DATA_PATH}/Flow"
     OBS_STAGE_OUTPUT_PATH = f"{OBS_DATA_PATH}/Stage"
 
@@ -1121,6 +1122,81 @@ class RasPlanHdf(RasGeomHdf):
         """
         return self.reference_timeseries_output(reftype="lines")
 
+    def bc_line_timeseries_output(self, bc_line_name: str) -> xr.Dataset:
+        """Return timeseries output data for a specific boundary condition line from a HEC-RAS HDF plan file.
+
+        Parameters
+        ----------
+        bc_line_name : str
+            The name of the boundary condition line.
+
+        Returns
+        -------
+        xr.Dataset
+            An xarray Dataset with timeseries output data for the specified boundary condition line.
+        """
+        path = f"{self.BOUNDARY_CONDITIONS_OUTPUT_PATH}/{bc_line_name}"
+        dataset = self.get(path)
+        if dataset is None:
+            raise RasPlanHdfError(
+                f"Could not find HDF group at path '{path}'."
+                f" Does the Plan HDF file contain boundary condition output data for '{bc_line_name}'?"
+            )
+        columns = [c.decode("utf-8") for c in dataset.attrs["Columns"]]
+        ds = xr.Dataset()
+        try:
+            import dask.array as da
+
+            # TODO: user-specified chunks?
+            values = da.from_array(dataset, chunks=dataset.chunks)
+        except ImportError:
+            values = dataset[:]
+        for i, col in enumerate(columns):
+            units = dataset.attrs.get(col, None)
+            if units is not None:
+                units = units.decode("utf-8")
+            da = xr.DataArray(
+                values[:, i],
+                name=col,
+                dims=["time"],
+                coords={
+                    "time": self.unsteady_datetimes(),
+                },
+                attrs={
+                    "units": units,
+                    "hdf_path": f"{path}",
+                },
+            )
+            ds[col] = da
+        return ds
+
+    def bc_lines_timeseries_output(self) -> xr.Dataset:
+        """Return timeseries output data for boundary conditions lines from a HEC-RAS HDF plan file.
+
+        Returns
+        -------
+        xr.Dataset
+            An xarray Dataset with timeseries output data for boundary conditions lines.
+        """
+        df_bc_lines = self.bc_lines()
+        bc_lines_names = df_bc_lines["name"]
+        datasets = []
+        for bc_line_name in bc_lines_names:
+            ds_bc_line = self.bc_line_timeseries_output(bc_line_name)
+            datasets.append(ds_bc_line)
+        bc_line_ids = df_bc_lines["bc_line_id"].values
+        ds: xr.Dataset = xr.concat(
+            datasets, dim=pd.Index(bc_line_ids, name="bc_line_id")
+        )
+        ds = ds.assign_coords(
+            {
+                "bc_line_name": ("bc_line_id", bc_lines_names),
+                "bc_line_type": ("bc_line_id", df_bc_lines["type"]),
+                "mesh_name": ("bc_line_id", df_bc_lines["mesh_name"]),
+            }
+        )
+        return ds
+
     def observed_timeseries_input(self, vartype: str = "Flow") -> xr.DataArray:
         """Return observed timeseries input data for reference lines and points from a HEC-RAS HDF plan file.
 
@@ -1381,10 +1457,49 @@ class RasPlanHdf(RasGeomHdf):
         """
         return self.get_attrs(self.VOLUME_ACCOUNTING_PATH)
 
-    def enroachment_points(self) -> GeoDataFrame:  # noqa: D102
-        raise NotImplementedError
+    def encroachment_points(self, profile_name: str) -> GeoDataFrame:
+        """Return encroachment points from a HEC-RAS plan HDF file based on a user-specified flow profile.
+
+        Returns
+        -------
+        GeoDataframe
+            A GeoDataFrame with cross-section encroachments represented as Point geometry features along with pertinent attributes.
+        """
+        cross_sections = self.cross_sections()
+        cross_sections["Enc_Profile"] = profile_name
+
+        leftmost_sta = self.cross_sections_elevations()["elevation info"].apply(
+            lambda x: x[0][0]
+        )
+        left_enc_sta = self.cross_sections_additional_enc_station_left()[profile_name]
+        left_enc_points = GeoDataFrame(
+            pd.concat(
+                [
+                    cross_sections[["River", "Reach", "RS", "Enc_Profile"]],
+                    left_enc_sta.rename("Enc_Sta", inplace=False),
+                ],
+                axis=1,
+            ),
+            geometry=cross_sections.geometry.interpolate(left_enc_sta - leftmost_sta),
+        )
+        left_enc_points["Side"] = "Left"
+
+        right_enc_sta = self.cross_sections_additional_enc_station_right()[profile_name]
+        right_enc_points = GeoDataFrame(
+            pd.concat(
+                [
+                    cross_sections[["River", "Reach", "RS", "Enc_Profile"]],
+                    right_enc_sta.rename("Enc_Sta", inplace=False),
+                ],
+                axis=1,
+            ),
+            geometry=cross_sections.geometry.interpolate(right_enc_sta - leftmost_sta),
+        )
+        right_enc_points["Side"] = "Right"
+
+        return GeoDataFrame(pd.concat([left_enc_points, right_enc_points]))
 
-    def steady_flow_names(self) -> list:
+    def steady_flow_names(self) -> List[str]:
         """Return the profile information for each steady flow event.
 
         Returns
@@ -1393,7 +1508,7 @@ class RasPlanHdf(RasGeomHdf):
             A Dataframe containing the profile names for each event
         """
         if self.STEADY_PROFILES_PATH not in self:
-            return pd.DataFrame()
+            return []
 
         profile_data = self[self.STEADY_PROFILES_PATH]
         profile_attrs = profile_data["Profile Names"][()]

{rashdf-0.7.2.dist-info → rashdf-0.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: rashdf
-Version: 0.7.2
+Version: 0.8.1
 Summary: Read data from HEC-RAS HDF files.
 Project-URL: repository, https://github.com/fema-ffrd/rashdf
 Classifier: Development Status :: 4 - Beta
@@ -16,7 +16,7 @@ License-File: LICENSE
 Requires-Dist: h5py
 Requires-Dist: geopandas<2.0,>=1.0
 Requires-Dist: pyarrow
-Requires-Dist: xarray
+Requires-Dist: xarray<=2025.4.0
 Provides-Extra: dev
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
@@ -28,10 +28,12 @@ Requires-Dist: dask; extra == "dev"
 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"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Dynamic: license-file
 
 # rashdf
 [![CI](https://github.com/fema-ffrd/rashdf/actions/workflows/continuous-integration.yml/badge.svg?branch=main)](https://github.com/fema-ffrd/rashdf/actions/workflows/continuous-integration.yml)

rashdf-0.8.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+cli.py,sha256=HbyrdUVKfrmtU2T9ljKTPQ-ugomJqYbCA26ghGJDJh0,6588
+rashdf/__init__.py,sha256=XXFtJDgLPCimqAhfsFz_pTWYECJiRT0i-Kb1uflXmVU,156
+rashdf/base.py,sha256=cAQJX1aeBJKb3MJ06ltpbRTUaZX5NkuxpR1J4f7FyTU,2507
+rashdf/geom.py,sha256=-GmHmddcdIcfOn-SFS940WyDLUilW9inrp_nuZ8aTHo,28306
+rashdf/plan.py,sha256=d8YhpC6cV8rhh3qf1o12TbhUvo_4pMh75vIdDkcAvjE,63971
+rashdf/utils.py,sha256=Cba6sULF0m0jg6CQass4bPm2oxTd_avoe1pRQxq082c,10896
+rashdf-0.8.1.dist-info/licenses/LICENSE,sha256=L_0QaLpQVHPcglVjiaJPnOocwzP8uXevDRjUPr9DL1Y,1065
+rashdf-0.8.1.dist-info/METADATA,sha256=7h2fJs_IYE81euocfUfqCtY0qSPoMOJ-yV5kKdZ9Zco,6072
+rashdf-0.8.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rashdf-0.8.1.dist-info/entry_points.txt,sha256=LHHMR1lLy4wRyscMuW1RlYDXemtPgqQhNcILz0DtStY,36
+rashdf-0.8.1.dist-info/top_level.txt,sha256=SrmLb6FFTJtM_t6O1v0M0JePshiQJMHr0yYVkHL7ztk,11
+rashdf-0.8.1.dist-info/RECORD,,

{rashdf-0.7.2.dist-info → rashdf-0.8.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

rashdf-0.7.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-cli.py,sha256=yItWmCxnYLcuOpJVRpUsfv_NLS9IxLjojZB9GrxfKAU,6571
-rashdf/__init__.py,sha256=XXFtJDgLPCimqAhfsFz_pTWYECJiRT0i-Kb1uflXmVU,156
-rashdf/base.py,sha256=cAQJX1aeBJKb3MJ06ltpbRTUaZX5NkuxpR1J4f7FyTU,2507
-rashdf/geom.py,sha256=2aTfj6mqZGP6rysflQ5L8FeItlYJsknO00sKHo-yaTw,26090
-rashdf/plan.py,sha256=vGqxQssz6ObxIO48Vej-d7EtBJBZ90zCrt7gC5pHATE,59558
-rashdf/utils.py,sha256=Cba6sULF0m0jg6CQass4bPm2oxTd_avoe1pRQxq082c,10896
-rashdf-0.7.2.dist-info/LICENSE,sha256=L_0QaLpQVHPcglVjiaJPnOocwzP8uXevDRjUPr9DL1Y,1065
-rashdf-0.7.2.dist-info/METADATA,sha256=KkdJpptV8_IoCQwIa9ErfEGIJIz8rLMUvBZkdXuhDAQ,5994
-rashdf-0.7.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-rashdf-0.7.2.dist-info/entry_points.txt,sha256=LHHMR1lLy4wRyscMuW1RlYDXemtPgqQhNcILz0DtStY,36
-rashdf-0.7.2.dist-info/top_level.txt,sha256=SrmLb6FFTJtM_t6O1v0M0JePshiQJMHr0yYVkHL7ztk,11
-rashdf-0.7.2.dist-info/RECORD,,