rashdf 0.8.4__py3-none-any.whl → 0.9.0__py3-none-any.whl

cli.py

@@ -26,6 +26,7 @@ COMMANDS = [
     "reference_lines",
     "reference_points",
     "structures",
+    "generate_bridge_xs_lines",
 ]
 
 

rashdf/geom.py

@@ -27,6 +27,8 @@ from .utils import (
     convert_ras_hdf_value,
     get_first_hdf_group,
     hdf5_attrs_to_dict,
+    copy_lines_parallel,
+    experimental,
 )
 
 
@@ -474,6 +476,67 @@ class RasGeomHdf(RasHdf):
     def connections(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
+    @experimental
+    def generate_bridge_xs_lines(self, datetime_to_str: bool = False) -> GeoDataFrame:
+        """[EXPERIMENTAL] Attempt to return the 2D bridge cross-section lines.
+
+        This method attempts to generate the cross-section lines for bridges modeled
+        within 2D mesh areas. It should be noted that these lines are not explicitly
+        stored within the HEC-RAS Geometry HDF file, and are instead generated based
+        on the bridge attributes and centerline geometry. As such, the accuracy of
+        these lines may vary depending on the complexity of the bridge geometry and
+        output from this method should be reviewed for accuracy.
+
+        Parameters
+        ----------
+        datetime_to_str : bool, optional
+            If True, convert datetime values to string format (default: False).
+
+        Returns
+        -------
+        GeoDataFrame
+            A GeoDataFrame containing the 2D bridge cross-section lines if they exist.
+        """
+        profile_info = self.get(self.GEOM_STRUCTURES_PATH + "/Table Info")
+        structs = self.structures().merge(
+            pd.DataFrame(profile_info[()] if profile_info is not None else None),
+            left_index=True,
+            right_index=True,
+        )
+        if structs.empty:
+            return GeoDataFrame()
+
+        bridges = structs[structs["Mode"] == "Bridge Opening"].copy()
+        if bridges.empty:
+            return GeoDataFrame()
+
+        inside_buffer_widths = bridges["Weir Width"] / 2
+        inside_bridge_xs = copy_lines_parallel(
+            bridges, inside_buffer_widths.values, "struct_id"
+        )
+        inside_bridge_xs["level"] = "inside"
+
+        outside_buffer_widths = inside_buffer_widths + bridges["Upstream Distance"]
+        outside_bridge_xs = copy_lines_parallel(
+            bridges, outside_buffer_widths.values, "struct_id"
+        )
+        outside_bridge_xs["level"] = "outside"
+
+        br_xs = GeoDataFrame(
+            pd.concat([inside_bridge_xs, outside_bridge_xs], ignore_index=True),
+            geometry="geometry",
+        )
+        br_xs.side = br_xs.side.apply(
+            lambda x: "upstream" if x == "right" else "downstream"
+        )
+
+        if datetime_to_str:
+            br_xs[self.LAST_EDITED_COLUMN] = br_xs[self.LAST_EDITED_COLUMN].apply(
+                lambda x: pd.Timestamp.isoformat(x)
+            )
+
+        return br_xs
+
     def ic_points(self) -> GeoDataFrame:  # noqa D102
         """Return initial conditions points.
 

rashdf/plan.py

@@ -1178,7 +1178,7 @@ class RasPlanHdf(RasGeomHdf):
         xr.Dataset
             An xarray Dataset with timeseries output data for boundary conditions lines.
         """
-        df_bc_lines = self.bc_lines()
+        df_bc_lines = super().bc_lines()
         bc_lines_names = df_bc_lines["name"]
         datasets = []
         for bc_line_name in bc_lines_names:
@@ -1197,6 +1197,57 @@ class RasPlanHdf(RasGeomHdf):
         )
         return ds
 
+    def bc_lines(
+        self, include_output: bool = True, datetime_to_str: bool = False
+    ) -> GeoDataFrame:
+        """Return the boundary condition lines from a HEC-RAS HDF plan file.
+
+        Optionally include summary output data for each boundary condition line.
+
+        Parameters
+        ----------
+        include_output : bool, optional
+            If True, include summary output data in the GeoDataFrame. (default: True)
+        datetime_to_str : bool, optional
+            If True, convert datetime columns to strings. (default: False)
+
+        Returns
+        -------
+        GeoDataFrame
+            A GeoDataFrame with boundary condition line geometry and summary output data.
+        """
+        gdf = super().bc_lines()
+        if include_output is False:
+            return gdf
+
+        ds = self.bc_lines_timeseries_output()
+        summary = {
+            "bc_line_id": ds.coords["bc_line_id"].values,
+            "name": ds.coords["bc_line_name"].values,
+            "mesh_name": ds.coords["mesh_name"].values,
+            "type": ds.coords["bc_line_type"].values,
+        }
+
+        for var in ds.data_vars:
+            abbrev = "q" if var.lower() == "flow" else "ws"
+            summary[f"max_{abbrev}"] = ds[var].max(dim="time").values
+            summary[f"max_{abbrev}_time"] = (
+                ds[var].time[ds[var].argmax(dim="time")].values
+            )
+            summary[f"min_{abbrev}"] = ds[var].min(dim="time").values
+            summary[f"min_{abbrev}_time"] = (
+                ds[var].time[ds[var].argmin(dim="time")].values
+            )
+
+        gdf_with_output = gdf.merge(
+            pd.DataFrame(summary),
+            on=["bc_line_id", "name", "mesh_name", "type"],
+            how="left",
+        )
+        return (
+            df_datetimes_to_str(gdf_with_output) if datetime_to_str else gdf_with_output
+        )
+
     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.
 

rashdf/utils.py

@@ -8,6 +8,38 @@ from datetime import datetime, timedelta
 import re
 from typing import Any, Callable, List, Tuple, Union, Optional
 import warnings
+from shapely import LineString, MultiLineString
+import geopandas as gpd
+
+
+def experimental(func) -> Callable:
+    """
+    Declare a function to be experimental.
+
+    This is a decorator which can be used to mark functions as experimental.
+    It will result in a warning being emitted when the function is used.
+
+    Parameters
+    ----------
+        func: The function to be declared experimental.
+
+    Returns
+    -------
+        The decorated function.
+    """
+
+    def new_func(*args, **kwargs):
+        warnings.warn(
+            f"{func.__name__} is experimental and could change in the future. Please review output carefully.",
+            category=UserWarning,
+            stacklevel=2,
+        )
+        return func(*args, **kwargs)
+
+    new_func.__name__ = func.__name__
+    new_func.__doc__ = func.__doc__
+    new_func.__dict__.update(func.__dict__)
+    return new_func
 
 
 def deprecated(func) -> Callable:
@@ -354,3 +386,131 @@ def ras_timesteps_to_datetimes(
         start_time + pd.Timedelta(timestep, unit=time_unit).round(round_to)
         for timestep in timesteps.astype(np.float64)
     ]
+
+
+def remove_line_ends(
+    geom: Union[LineString, MultiLineString],
+) -> Union[LineString, MultiLineString]:
+    """
+    Remove endpoints from a LineString or each LineString in a MultiLineString if longer than 3 points.
+
+    Parameters
+    ----------
+    geom : LineString or MultiLineString
+        The geometry to trim.
+
+    Returns
+    -------
+    LineString or MultiLineString
+        The trimmed geometry, or original if not enough points to trim.
+    """
+    if isinstance(geom, LineString):
+        coords = list(geom.coords)
+        if len(coords) > 3:
+            return LineString(coords[1:-1])
+        return geom
+    elif isinstance(geom, MultiLineString):
+        trimmed = []
+        for line in geom.geoms:
+            coords = list(line.coords)
+            if len(coords) > 3:
+                trimmed.append(LineString(coords[1:-1]))
+            else:
+                trimmed.append(line)
+        return MultiLineString(trimmed)
+    return geom
+
+
+def reverse_line(
+    line: Union[LineString, MultiLineString],
+) -> Union[LineString, MultiLineString]:
+    """
+    Reverse the order of coordinates in a LineString or each LineString in a MultiLineString.
+
+    Parameters
+    ----------
+    line : LineString or MultiLineString
+        The geometry to reverse.
+
+    Returns
+    -------
+    LineString or MultiLineString
+        The reversed geometry.
+    """
+    return (
+        MultiLineString([LineString(list(line.coords)[::-1]) for line in line.geoms])
+        if isinstance(line, MultiLineString)
+        else LineString(list(line.coords)[::-1])
+    )
+
+
+def copy_lines_parallel(
+    lines: gpd.GeoDataFrame,
+    offset_ft: Union[np.ndarray, float],
+    id_col: str = "id",
+) -> gpd.GeoDataFrame:
+    """
+    Create parallel copies of line geometries offset to the left and right, then trim and erase overlaps.
+
+    Parameters
+    ----------
+    lines : gpd.GeoDataFrame
+        GeoDataFrame containing line geometries.
+    offset_ft : float or np.ndarray
+        Offset distance (in feet) for parallel lines.
+    id_col : str
+        Name of the column containing unique structure IDs. Default is "id".
+
+    Returns
+    -------
+    gpd.GeoDataFrame
+        GeoDataFrame with trimmed, parallel left and right offset lines.
+    """
+    # Offset lines to the left
+    left = lines.copy()
+    offset_ft = offset_ft.astype(float)
+    left.geometry = lines.buffer(
+        offset_ft, cap_style="flat", single_sided=True, resolution=3
+    ).boundary
+    left["side"] = "left"
+
+    # Offset lines to the right (reverse direction first)
+    reversed_lines = lines.copy()
+    reversed_lines.geometry = reversed_lines.geometry.apply(reverse_line)
+    right = lines.copy()
+    right.geometry = reversed_lines.buffer(
+        offset_ft, cap_style="flat", single_sided=True, resolution=3
+    ).boundary.apply(reverse_line)
+    right["side"] = "right"
+
+    # Combine left and right boundaries
+    boundaries = pd.concat([left, right], ignore_index=True)
+    boundaries_gdf = gpd.GeoDataFrame(boundaries, crs=lines.crs, geometry="geometry")
+
+    # Erase buffer caps
+    erase_buffer = 0.1
+    cleaned_list = []
+    eraser = gpd.GeoDataFrame(
+        {
+            id_col: lines[id_col],
+            "geometry": lines.buffer(
+                offset_ft - erase_buffer, cap_style="square", resolution=3
+            ),
+        },
+        crs=lines.crs,
+    )
+    for id in lines[id_col].unique():
+        cleaned_list.append(
+            gpd.overlay(
+                boundaries_gdf[boundaries_gdf[id_col] == id],
+                eraser[eraser[id_col] == id],
+                how="difference",
+            )
+        )
+    cleaned = gpd.GeoDataFrame(
+        pd.concat(cleaned_list, ignore_index=True), crs=lines.crs, geometry="geometry"
+    )
+
+    # trim ends
+    cleaned["geometry"] = cleaned["geometry"].apply(remove_line_ends)
+    return cleaned

{rashdf-0.8.4.dist-info → rashdf-0.9.0.dist-info}/METADATA

@@ -1,16 +1,16 @@
 Metadata-Version: 2.4
 Name: rashdf
-Version: 0.8.4
+Version: 0.9.0
 Summary: Read data from HEC-RAS HDF files.
 Project-URL: repository, https://github.com/fema-ffrd/rashdf
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: h5py

rashdf-0.9.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+cli.py,sha256=SlMHkoosQKO2BDsF34CeYSHjD221AzGYGaKd0T2sOig,6866
+rashdf/__init__.py,sha256=XXFtJDgLPCimqAhfsFz_pTWYECJiRT0i-Kb1uflXmVU,156
+rashdf/base.py,sha256=cAQJX1aeBJKb3MJ06ltpbRTUaZX5NkuxpR1J4f7FyTU,2507
+rashdf/geom.py,sha256=qieDgMxKrPcUqyVQUbCpRfrDo8VoOqh9Rx7OXOC_nRI,31192
+rashdf/plan.py,sha256=r5_rXqBmJKQ0obm-iEBYpB28eper9jw4PwBcXkwEvSo,65483
+rashdf/utils.py,sha256=-p8nQzotN5jakUCzpmKSYJOvYned8cD13WFjQhX3q1M,15845
+rashdf-0.9.0.dist-info/licenses/LICENSE,sha256=L_0QaLpQVHPcglVjiaJPnOocwzP8uXevDRjUPr9DL1Y,1065
+rashdf-0.9.0.dist-info/METADATA,sha256=yLj9yYCZdDUJC5_ZyluCMVxVKhzAzp6uWADXPi82c_s,6073
+rashdf-0.9.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rashdf-0.9.0.dist-info/entry_points.txt,sha256=LHHMR1lLy4wRyscMuW1RlYDXemtPgqQhNcILz0DtStY,36
+rashdf-0.9.0.dist-info/top_level.txt,sha256=SrmLb6FFTJtM_t6O1v0M0JePshiQJMHr0yYVkHL7ztk,11
+rashdf-0.9.0.dist-info/RECORD,,

rashdf-0.8.4.dist-info/RECORD

@@ -1,12 +0,0 @@
-cli.py,sha256=NtO1bHaiM8GBW5Gv9eSF8Iu-ekwTIQAfV_hd7DBXyLQ,6834
-rashdf/__init__.py,sha256=XXFtJDgLPCimqAhfsFz_pTWYECJiRT0i-Kb1uflXmVU,156
-rashdf/base.py,sha256=cAQJX1aeBJKb3MJ06ltpbRTUaZX5NkuxpR1J4f7FyTU,2507
-rashdf/geom.py,sha256=O2PMYY7w7fdW2U4u0rsbWeEDKAmsUh4-49ro-xUMc4A,28755
-rashdf/plan.py,sha256=ctkfLBqocF2TpU6wYygXkxE2voCJa8WyVGYlimsyxS4,63612
-rashdf/utils.py,sha256=I23Zij1EFi9v99UXFIJVGaZ2JN48-q5TK1aNsKwL4vE,11113
-rashdf-0.8.4.dist-info/licenses/LICENSE,sha256=L_0QaLpQVHPcglVjiaJPnOocwzP8uXevDRjUPr9DL1Y,1065
-rashdf-0.8.4.dist-info/METADATA,sha256=ZHbiO37k11MIami2y_JyuRzlLNk_qsgiLCx2Gi6TDKs,6072
-rashdf-0.8.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rashdf-0.8.4.dist-info/entry_points.txt,sha256=LHHMR1lLy4wRyscMuW1RlYDXemtPgqQhNcILz0DtStY,36
-rashdf-0.8.4.dist-info/top_level.txt,sha256=SrmLb6FFTJtM_t6O1v0M0JePshiQJMHr0yYVkHL7ztk,11
-rashdf-0.8.4.dist-info/RECORD,,