ras-commander 0.44.0__tar.gz → 0.45.0__tar.gz

{ras_commander-0.44.0/ras_commander.egg-info → ras_commander-0.45.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ras-commander
-Version: 0.44.0
+Version: 0.45.0
 Summary: A Python library for automating HEC-RAS operations
 Home-page: https://github.com/billk-FM/ras-commander
 Author: William M. Katzenmeyer

ras_commander-0.45.0/ras_commander/HdfPipe.py

@@ -0,0 +1,262 @@
+import h5py
+import numpy as np
+import pandas as pd
+import geopandas as gpd
+import xarray as xr
+from pathlib import Path
+from shapely.geometry import LineString, Point
+from typing import List, Dict, Any, Optional, Union
+from .HdfBase import HdfBase
+from .HdfUtils import HdfUtils
+from .Decorators import standardize_input, log_call
+from .LoggingConfig import get_logger
+
+logger = get_logger(__name__)
+
+class HdfPipe:
+    """
+    A class for handling pipe network related data from HEC-RAS HDF files.
+    """
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pipe_conduits(hdf_path: Path) -> gpd.GeoDataFrame:
+        """
+        Extract pipe conduit data from the HDF file.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+
+        Returns:
+            gpd.GeoDataFrame: GeoDataFrame containing pipe conduit data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Extract pipe conduit data
+                polyline_info = hdf['/Geometry/Pipe Conduits/Polyline Info'][()]
+                polyline_points = hdf['/Geometry/Pipe Conduits/Polyline Points'][()]
+                terrain_profiles_info = hdf['/Geometry/Pipe Conduits/Terrain Profiles Info'][()]
+
+                # Create geometries
+                geometries = []
+                for start, count, _, _ in polyline_info:
+                    points = polyline_points[start:start+count]
+                    geometries.append(LineString(points))
+
+                # Create GeoDataFrame
+                gdf = gpd.GeoDataFrame(geometry=geometries)
+                gdf['conduit_id'] = range(len(gdf))
+                gdf['terrain_profile_start'] = terrain_profiles_info[:, 0]
+                gdf['terrain_profile_count'] = terrain_profiles_info[:, 1]
+
+                # Set CRS if available
+                crs = HdfUtils.projection(hdf_path)
+                if crs:
+                    gdf.set_crs(crs, inplace=True)
+
+                return gdf
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pipe conduit data: {e}")
+            raise
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pipe_nodes(hdf_path: Path) -> gpd.GeoDataFrame:
+        """
+        Extract pipe node data from the HDF file.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+
+        Returns:
+            gpd.GeoDataFrame: GeoDataFrame containing pipe node data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Extract pipe node data
+                points = hdf['/Geometry/Pipe Nodes/Points'][()]
+                attributes = hdf['/Geometry/Pipe Nodes/Attributes'][()]
+
+                # Create geometries
+                geometries = [Point(x, y) for x, y in points]
+
+                # Create GeoDataFrame
+                gdf = gpd.GeoDataFrame(geometry=geometries)
+                gdf['node_id'] = range(len(gdf))
+
+                # Add attributes
+                for name in attributes.dtype.names:
+                    gdf[name] = attributes[name]
+
+                # Set CRS if available
+                crs = HdfUtils.projection(hdf_path)
+                if crs:
+                    gdf.set_crs(crs, inplace=True)
+
+                return gdf
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pipe node data: {e}")
+            raise
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pipe_network_timeseries(hdf_path: Path, variable: str) -> xr.DataArray:
+        """
+        Extract timeseries data for a specific variable in the pipe network.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+            variable (str): Variable to extract (e.g., "Cell Courant", "Cell Water Surface").
+
+        Returns:
+            xr.DataArray: DataArray containing the timeseries data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+            ValueError: If an invalid variable is specified.
+        """
+        valid_variables = [
+            "Cell Courant", "Cell Water Surface", "Face Flow", "Face Velocity",
+            "Face Water Surface", "Pipes/Pipe Flow DS", "Pipes/Pipe Flow US",
+            "Pipes/Vel DS", "Pipes/Vel US", "Nodes/Depth", "Nodes/Drop Inlet Flow",
+            "Nodes/Water Surface"
+        ]
+
+        if variable not in valid_variables:
+            raise ValueError(f"Invalid variable. Must be one of: {', '.join(valid_variables)}")
+
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Extract timeseries data
+                data_path = f"/Results/Unsteady/Output/Output Blocks/DSS Hydrograph Output/Unsteady Time Series/Pipe Networks/Davis/{variable}"
+                data = hdf[data_path][()]
+
+                # Extract time information
+                time = HdfBase._get_unsteady_datetimes(hdf)
+
+                # Create DataArray
+                da = xr.DataArray(
+                    data=data,
+                    dims=['time', 'location'],
+                    coords={'time': time, 'location': range(data.shape[1])},
+                    name=variable
+                )
+
+                # Add attributes
+                da.attrs['units'] = hdf[data_path].attrs.get('Units', b'').decode('utf-8')
+                da.attrs['variable'] = variable
+
+                return da
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pipe network timeseries data: {e}")
+            raise
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pipe_network_summary(hdf_path: Path) -> pd.DataFrame:
+        """
+        Extract summary data for pipe networks from the HDF file.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+
+        Returns:
+            pd.DataFrame: DataFrame containing pipe network summary data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Extract summary data
+                summary_path = "/Results/Unsteady/Summary/Pipe Network"
+                if summary_path not in hdf:
+                    logger.warning("Pipe Network summary data not found in HDF file")
+                    return pd.DataFrame()
+
+                summary_data = hdf[summary_path][()]
+                
+                # Create DataFrame
+                df = pd.DataFrame(summary_data)
+
+                # Convert column names
+                df.columns = [col.decode('utf-8') for col in df.columns]
+
+                return df
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pipe network summary data: {e}")
+            raise
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pipe_profile(hdf_path: Path, conduit_id: int) -> pd.DataFrame:
+        """
+        Extract the profile data for a specific pipe conduit.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+            conduit_id (int): ID of the conduit to extract profile for.
+
+        Returns:
+            pd.DataFrame: DataFrame containing the pipe profile data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+            IndexError: If the specified conduit_id is out of range.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Get conduit info
+                terrain_profiles_info = hdf['/Geometry/Pipe Conduits/Terrain Profiles Info'][()]
+                
+                if conduit_id >= len(terrain_profiles_info):
+                    raise IndexError(f"conduit_id {conduit_id} is out of range")
+
+                start, count = terrain_profiles_info[conduit_id]
+
+                # Extract profile data
+                profile_values = hdf['/Geometry/Pipe Conduits/Terrain Profiles Values'][start:start+count]
+
+                # Create DataFrame
+                df = pd.DataFrame(profile_values, columns=['Station', 'Elevation'])
+
+                return df
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except IndexError as e:
+            logger.error(f"Invalid conduit_id: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pipe profile data: {e}")
+            raise
+        
+        

ras_commander-0.45.0/ras_commander/HdfPump.py

@@ -0,0 +1,255 @@
+import h5py
+import numpy as np
+import pandas as pd
+import geopandas as gpd
+import xarray as xr
+from pathlib import Path
+from shapely.geometry import Point
+from typing import List, Dict, Any, Optional, Union
+from .HdfUtils import HdfUtils
+from .Decorators import standardize_input, log_call
+from .LoggingConfig import get_logger
+
+logger = get_logger(__name__)
+
+class HdfPump:
+    """
+    A class for handling pump station related data from HEC-RAS HDF files.
+    """
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pump_stations(hdf_path: Path) -> gpd.GeoDataFrame:
+        """
+        Extract pump station data from the HDF file.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+
+        Returns:
+            gpd.GeoDataFrame: GeoDataFrame containing pump station data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Extract pump station data
+                attributes = hdf['/Geometry/Pump Stations/Attributes'][()]
+                points = hdf['/Geometry/Pump Stations/Points'][()]
+
+                # Create geometries
+                geometries = [Point(x, y) for x, y in points]
+
+                # Create GeoDataFrame
+                gdf = gpd.GeoDataFrame(geometry=geometries)
+                gdf['station_id'] = range(len(gdf))
+
+                # Add attributes
+                for name in attributes.dtype.names:
+                    gdf[name] = attributes[name]
+
+                # Set CRS if available
+                crs = HdfUtils.projection(hdf_path)
+                if crs:
+                    gdf.set_crs(crs, inplace=True)
+
+                return gdf
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pump station data: {e}")
+            raise
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pump_groups(hdf_path: Path) -> pd.DataFrame:
+        """
+        Extract pump group data from the HDF file.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+
+        Returns:
+            pd.DataFrame: DataFrame containing pump group data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Extract pump group data
+                attributes = hdf['/Geometry/Pump Stations/Pump Groups/Attributes'][()]
+                efficiency_curves_info = hdf['/Geometry/Pump Stations/Pump Groups/Efficiency Curves Info'][()]
+                efficiency_curves_values = hdf['/Geometry/Pump Stations/Pump Groups/Efficiency Curves Values'][()]
+
+                # Create DataFrame
+                df = pd.DataFrame(attributes)
+
+                # Add efficiency curve data
+                df['efficiency_curve_start'] = efficiency_curves_info[:, 0]
+                df['efficiency_curve_count'] = efficiency_curves_info[:, 1]
+
+                # Process efficiency curves
+                def get_efficiency_curve(start, count):
+                    return efficiency_curves_values[start:start+count].tolist()
+
+                df['efficiency_curve'] = df.apply(lambda row: get_efficiency_curve(row['efficiency_curve_start'], row['efficiency_curve_count']), axis=1)
+
+                return df
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pump group data: {e}")
+            raise
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pump_station_timeseries(hdf_path: Path, pump_station: str) -> xr.DataArray:
+        """
+        Extract timeseries data for a specific pump station.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+            pump_station (str): Name of the pump station.
+
+        Returns:
+            xr.DataArray: DataArray containing the timeseries data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+            ValueError: If the specified pump station is not found.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Check if the pump station exists
+                pumping_stations_path = "/Results/Unsteady/Output/Output Blocks/DSS Hydrograph Output/Unsteady Time Series/Pumping Stations"
+                if pump_station not in hdf[pumping_stations_path]:
+                    raise ValueError(f"Pump station '{pump_station}' not found in HDF file")
+
+                # Extract timeseries data
+                data_path = f"{pumping_stations_path}/{pump_station}/Structure Variables"
+                data = hdf[data_path][()]
+
+                # Extract time information
+                time = HdfBase._get_unsteady_datetimes(hdf)
+
+                # Create DataArray
+                da = xr.DataArray(
+                    data=data,
+                    dims=['time', 'variable'],
+                    coords={'time': time, 'variable': ['Flow', 'Stage HW', 'Stage TW', 'Pump Station', 'Pumps on']},
+                    name=pump_station
+                )
+
+                # Add attributes
+                da.attrs['units'] = hdf[data_path].attrs.get('Variable_Unit', b'').decode('utf-8')
+                da.attrs['pump_station'] = pump_station
+
+                return da
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except ValueError as e:
+            logger.error(str(e))
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pump station timeseries data: {e}")
+            raise
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pump_station_summary(hdf_path: Path) -> pd.DataFrame:
+        """
+        Extract summary data for pump stations from the HDF file.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+
+        Returns:
+            pd.DataFrame: DataFrame containing pump station summary data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Extract summary data
+                summary_path = "/Results/Unsteady/Summary/Pump Station"
+                if summary_path not in hdf:
+                    logger.warning("Pump Station summary data not found in HDF file")
+                    return pd.DataFrame()
+
+                summary_data = hdf[summary_path][()]
+                
+                # Create DataFrame
+                df = pd.DataFrame(summary_data)
+
+                # Convert column names
+                df.columns = [col.decode('utf-8') for col in df.columns]
+
+                return df
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pump station summary data: {e}")
+            raise
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pump_operation_data(hdf_path: Path, pump_station: str) -> pd.DataFrame:
+        """
+        Extract pump operation data for a specific pump station.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+            pump_station (str): Name of the pump station.
+
+        Returns:
+            pd.DataFrame: DataFrame containing pump operation data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+            ValueError: If the specified pump station is not found.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Check if the pump station exists
+                pump_stations_path = "/Results/Unsteady/Output/Output Blocks/DSS Profile Output/Unsteady Time Series/Pumping Stations"
+                if pump_station not in hdf[pump_stations_path]:
+                    raise ValueError(f"Pump station '{pump_station}' not found in HDF file")
+
+                # Extract pump operation data
+                data_path = f"{pump_stations_path}/{pump_station}/Structure Variables"
+                data = hdf[data_path][()]
+
+                # Extract time information
+                time = HdfBase._get_unsteady_datetimes(hdf)
+
+                # Create DataFrame
+                df = pd.DataFrame(data, columns=['Flow', 'Stage HW', 'Stage TW', 'Pump Station', 'Pumps on'])
+                df['Time'] = time
+
+                return df
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except ValueError as e:
+            logger.error(str(e))
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pump operation data: {e}")
+            raise

{ras_commander-0.44.0 → ras_commander-0.45.0}/ras_commander/HdfResultsPlan.py

@@ -396,3 +396,6 @@ class HdfResultsPlan:
         except Exception as e:
             logger.error(f"Error in reference_summary_output: {str(e)}")
             return pd.DataFrame()  # Return an empty DataFrame on general error
+
+
+

ras_commander-0.45.0/ras_commander/HdfResultsXsec.py

@@ -0,0 +1,443 @@
+"""
+Class: HdfResultsXsec
+
+Attribution: A substantial amount of code in this file is sourced or derived 
+from the https://github.com/fema-ffrd/rashdf library, 
+released under MIT license and Copyright (c) 2024 fema-ffrd
+
+The file has been forked and modified for use in RAS Commander.
+"""
+
+from pathlib import Path
+from typing import Union, Optional, List
+
+import h5py
+import numpy as np
+import pandas as pd
+import xarray as xr
+
+from .HdfBase import HdfBase
+from .HdfUtils import HdfUtils
+from .Decorators import standardize_input, log_call
+from .LoggingConfig import get_logger
+
+logger = get_logger(__name__)
+
+class HdfResultsXsec:
+    """
+    A class for handling cross-section results from HEC-RAS HDF files.
+
+    This class provides methods to extract and process steady flow simulation results
+    for cross-sections, including water surface elevations, flow rates, energy grades,
+    and additional parameters such as encroachment stations and velocities.
+
+    The class relies on the HdfBase and HdfUtils classes for core HDF file operations
+    and utility functions.
+
+    Attributes:
+        None
+
+    Methods:
+        steady_profile_xs_output: Extract steady profile cross-section output for a specified variable.
+        cross_sections_wsel: Get water surface elevation data for cross-sections.
+        cross_sections_flow: Get flow data for cross-sections.
+        cross_sections_energy_grade: Get energy grade data for cross-sections.
+        cross_sections_additional_enc_station_left: Get left encroachment station data for cross-sections.
+        cross_sections_additional_enc_station_right: Get right encroachment station data for cross-sections.
+        cross_sections_additional_area_total: Get total ineffective area data for cross-sections.
+        cross_sections_additional_velocity_total: Get total velocity data for cross-sections.
+    """
+
+    @staticmethod
+    @standardize_input(file_type='plan_hdf')
+    def steady_profile_xs_output(hdf_path: Path, var: str, round_to: int = 2) -> pd.DataFrame:
+        """
+        Create a DataFrame from steady cross section results based on the specified variable.
+
+        Parameters:
+        ----------
+        hdf_path : Path
+            Path to the HEC-RAS plan HDF file.
+        var : str
+            The variable to extract from the steady cross section results.
+        round_to : int, optional
+            Number of decimal places to round the results to (default is 2).
+
+        Returns:
+        -------
+        pd.DataFrame
+            DataFrame containing the steady cross section results for the specified variable.
+        """
+        XS_STEADY_OUTPUT_ADDITIONAL = [
+            "Additional Encroachment Station Left",
+            "Additional Encroachment Station Right",
+            "Additional Area Ineffective Total",
+            "Additional Velocity Total",
+        ]
+                
+        try:
+            with h5py.File(hdf_path, 'r') as hdf_file:
+                # Determine the correct path based on the variable
+                if var in XS_STEADY_OUTPUT_ADDITIONAL:
+                    path = f"/Results/Steady/Cross Sections/Additional Output/{var}"
+                else:
+                    path = f"/Results/Steady/Cross Sections/{var}"
+                
+                # Check if the path exists in the HDF file
+                if path not in hdf_file:
+                    return pd.DataFrame()
+
+                # Get the profile names
+                profiles = HdfBase.steady_flow_names(hdf_path)
+                
+                # Extract the steady data
+                steady_data = hdf_file[path]
+                
+                # Create a DataFrame with profiles as index
+                df = pd.DataFrame(steady_data, index=profiles)
+                
+                # Transpose the DataFrame and round values
+                df_t = df.T.copy()
+                for p in profiles:
+                    df_t[p] = df_t[p].apply(lambda x: round(x, round_to))
+
+                return df_t
+        except Exception as e:
+            HdfUtils.logger.error(f"Failed to get steady profile cross section output: {str(e)}")
+            return pd.DataFrame()
+
+    @staticmethod
+    @standardize_input(file_type='plan_hdf')
+    def cross_sections_wsel(hdf_path: Path) -> pd.DataFrame:
+        """
+        Return the water surface elevation information for each 1D Cross Section.
+
+        Parameters:
+        ----------
+        hdf_path : Path
+            Path to the HEC-RAS plan HDF file.
+
+        Returns:
+        -------
+        pd.DataFrame
+            A DataFrame containing the water surface elevations for each cross section and event.
+        """
+        return HdfResultsXsec.steady_profile_xs_output(hdf_path, "Water Surface")
+
+    @staticmethod
+    @standardize_input(file_type='plan_hdf')
+    def cross_sections_flow(hdf_path: Path) -> pd.DataFrame:
+        """
+        Return the Flow information for each 1D Cross Section.
+
+        Parameters:
+        ----------
+        hdf_path : Path
+            Path to the HEC-RAS plan HDF file.
+
+        Returns:
+        -------
+        pd.DataFrame
+            A DataFrame containing the flow for each cross section and event.
+        """
+        return HdfResultsXsec.steady_profile_xs_output(hdf_path, "Flow")
+
+    @staticmethod
+    @standardize_input(file_type='plan_hdf')
+    def cross_sections_energy_grade(hdf_path: Path) -> pd.DataFrame:
+        """
+        Return the energy grade information for each 1D Cross Section.
+
+        Parameters:
+        ----------
+        hdf_path : Path
+            Path to the HEC-RAS plan HDF file.
+
+        Returns:
+        -------
+        pd.DataFrame
+            A DataFrame containing the energy grade for each cross section and event.
+        """
+        return HdfResultsXsec.steady_profile_xs_output(hdf_path, "Energy Grade")
+
+    @staticmethod
+    @standardize_input(file_type='plan_hdf')
+    def cross_sections_additional_enc_station_left(hdf_path: Path) -> pd.DataFrame:
+        """
+        Return the left side encroachment information for a floodway plan hdf.
+
+        Parameters:
+        ----------
+        hdf_path : Path
+            Path to the HEC-RAS plan HDF file.
+
+        Returns:
+        -------
+        pd.DataFrame
+            A DataFrame containing the cross sections left side encroachment stations.
+        """
+        return HdfResultsXsec.steady_profile_xs_output(
+            hdf_path, "Encroachment Station Left"
+        )
+
+    @staticmethod
+    @standardize_input(file_type='plan_hdf')
+    def cross_sections_additional_enc_station_right(hdf_path: Path) -> pd.DataFrame:
+        """
+        Return the right side encroachment information for a floodway plan hdf.
+
+        Parameters:
+        ----------
+        hdf_path : Path
+            Path to the HEC-RAS plan HDF file.
+
+        Returns:
+        -------
+        pd.DataFrame
+            A DataFrame containing the cross sections right side encroachment stations.
+        """
+        return HdfResultsXsec.steady_profile_xs_output(
+            hdf_path, "Encroachment Station Right"
+        )
+
+    @staticmethod
+    @standardize_input(file_type='plan_hdf')
+    def cross_sections_additional_area_total(hdf_path: Path) -> pd.DataFrame:
+        """
+        Return the 1D cross section area for each profile.
+
+        Parameters:
+        ----------
+        hdf_path : Path
+            Path to the HEC-RAS plan HDF file.
+
+        Returns:
+        -------
+        pd.DataFrame
+            A DataFrame containing the wet area inside the cross sections.
+        """
+        return HdfResultsXsec.steady_profile_xs_output(hdf_path, "Area Ineffective Total")
+
+    @staticmethod
+    @standardize_input(file_type='plan_hdf')
+    def cross_sections_additional_velocity_total(hdf_path: Path) -> pd.DataFrame:
+        """
+        Return the 1D cross section velocity for each profile.
+
+        Parameters:
+        ----------
+        hdf_path : Path
+            Path to the HEC-RAS plan HDF file.
+
+        Returns:
+        -------
+        pd.DataFrame
+            A DataFrame containing the velocity inside the cross sections.
+        """
+        return HdfResultsXsec.steady_profile_xs_output(hdf_path, "Velocity Total")
+
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pipe_network_summary(hdf_path: Path) -> pd.DataFrame:
+        """
+        Extract summary data for pipe networks from the HDF file.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+
+        Returns:
+            pd.DataFrame: DataFrame containing pipe network summary data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Extract summary data
+                summary_path = "/Results/Unsteady/Summary/Pipe Network"
+                if summary_path not in hdf:
+                    logger.warning("Pipe Network summary data not found in HDF file")
+                    return pd.DataFrame()
+
+                summary_data = hdf[summary_path][()]
+                
+                # Create DataFrame
+                df = pd.DataFrame(summary_data)
+
+                # Convert column names
+                df.columns = [col.decode('utf-8') if isinstance(col, bytes) else col for col in df.columns]
+
+                # Convert byte string values to regular strings
+                for col in df.columns:
+                    if df[col].dtype == object:
+                        df[col] = df[col].apply(lambda x: x.decode('utf-8') if isinstance(x, bytes) else x)
+
+                return df
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pipe network summary data: {e}")
+            raise
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pump_station_summary(hdf_path: Path) -> pd.DataFrame:
+        """
+        Extract summary data for pump stations from the HDF file.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+
+        Returns:
+            pd.DataFrame: DataFrame containing pump station summary data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Extract summary data
+                summary_path = "/Results/Unsteady/Summary/Pump Station"
+                if summary_path not in hdf:
+                    logger.warning("Pump Station summary data not found in HDF file")
+                    return pd.DataFrame()
+
+                summary_data = hdf[summary_path][()]
+                
+                # Create DataFrame
+                df = pd.DataFrame(summary_data)
+
+                # Convert column names
+                df.columns = [col.decode('utf-8') if isinstance(col, bytes) else col for col in df.columns]
+
+                # Convert byte string values to regular strings
+                for col in df.columns:
+                    if df[col].dtype == object:
+                        df[col] = df[col].apply(lambda x: x.decode('utf-8') if isinstance(x, bytes) else x)
+
+                return df
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pump station summary data: {e}")
+            raise
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pipe_network_profile_output(hdf_path: Path) -> pd.DataFrame:
+        """
+        Extract pipe network profile output data from the HDF file.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+
+        Returns:
+            pd.DataFrame: DataFrame containing pipe network profile output data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Extract profile output data
+                profile_path = "/Results/Unsteady/Output/Output Blocks/DSS Profile Output/Unsteady Time Series/Pipe Networks"
+                if profile_path not in hdf:
+                    logger.warning("Pipe Network profile output data not found in HDF file")
+                    return pd.DataFrame()
+
+                # Initialize an empty list to store data from all pipe networks
+                all_data = []
+
+                # Iterate through all pipe networks
+                for network in hdf[profile_path].keys():
+                    network_path = f"{profile_path}/{network}"
+                    
+                    # Extract data for each variable
+                    for var in hdf[network_path].keys():
+                        data = hdf[f"{network_path}/{var}"][()]
+                        
+                        # Create a DataFrame for this variable
+                        df = pd.DataFrame(data)
+                        df['Network'] = network
+                        df['Variable'] = var
+                        
+                        all_data.append(df)
+
+                # Concatenate all DataFrames
+                result_df = pd.concat(all_data, ignore_index=True)
+
+                # Add time information
+                time = HdfBase._get_unsteady_datetimes(hdf)
+                result_df['Time'] = [time[i] for i in result_df.index]
+
+                return result_df
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pipe network profile output data: {e}")
+            raise
+
+    @staticmethod
+    @log_call
+    @standardize_input(file_type='plan_hdf')
+    def get_pump_station_profile_output(hdf_path: Path) -> pd.DataFrame:
+        """
+        Extract pump station profile output data from the HDF file.
+
+        Args:
+            hdf_path (Path): Path to the HDF file.
+
+        Returns:
+            pd.DataFrame: DataFrame containing pump station profile output data.
+
+        Raises:
+            KeyError: If the required datasets are not found in the HDF file.
+        """
+        try:
+            with h5py.File(hdf_path, 'r') as hdf:
+                # Extract profile output data
+                profile_path = "/Results/Unsteady/Output/Output Blocks/DSS Profile Output/Unsteady Time Series/Pumping Stations"
+                if profile_path not in hdf:
+                    logger.warning("Pump Station profile output data not found in HDF file")
+                    return pd.DataFrame()
+
+                # Initialize an empty list to store data from all pump stations
+                all_data = []
+
+                # Iterate through all pump stations
+                for station in hdf[profile_path].keys():
+                    station_path = f"{profile_path}/{station}/Structure Variables"
+                    
+                    data = hdf[station_path][()]
+                    
+                    # Create a DataFrame for this pump station
+                    df = pd.DataFrame(data, columns=['Flow', 'Stage HW', 'Stage TW', 'Pump Station', 'Pumps on'])
+                    df['Station'] = station
+                    
+                    all_data.append(df)
+
+                # Concatenate all DataFrames
+                result_df = pd.concat(all_data, ignore_index=True)
+
+                # Add time information
+                time = HdfBase._get_unsteady_datetimes(hdf)
+                result_df['Time'] = [time[i] for i in result_df.index]
+
+                return result_df
+
+        except KeyError as e:
+            logger.error(f"Required dataset not found in HDF file: {e}")
+            raise
+        except Exception as e:
+            logger.error(f"Error extracting pump station profile output data: {e}")
+            raise

{ras_commander-0.44.0 → ras_commander-0.45.0}/ras_commander/__init__.py

@@ -32,6 +32,8 @@ from .HdfResultsXsec import HdfResultsXsec
 from .HdfStruc import HdfStruc
 from .HdfUtils import HdfUtils
 from .HdfXsec import HdfXsec
+from .HdfPump import HdfPump
+from .HdfPipe import HdfPipe
 
 # Define __all__ to specify what should be imported when using "from ras_commander import *"
 __all__ = [
@@ -45,6 +47,8 @@ __all__ = [
     "HdfStruc",
     "HdfUtils",
     "HdfXsec",
+    "HdfPump",
+    "HdfPipe",
     "standardize_input",
     "ras",
     "init_ras_project",

{ras_commander-0.44.0 → ras_commander-0.45.0/ras_commander.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ras-commander
-Version: 0.44.0
+Version: 0.45.0
 Summary: A Python library for automating HEC-RAS operations
 Home-page: https://github.com/billk-FM/ras-commander
 Author: William M. Katzenmeyer

{ras_commander-0.44.0 → ras_commander-0.45.0}/ras_commander.egg-info/SOURCES.txt

@@ -6,7 +6,9 @@ ras_commander/Decorators.py
 ras_commander/HdfBase.py
 ras_commander/HdfBndry.py
 ras_commander/HdfMesh.py
+ras_commander/HdfPipe.py
 ras_commander/HdfPlan.py
+ras_commander/HdfPump.py
 ras_commander/HdfResultsMesh.py
 ras_commander/HdfResultsPlan.py
 ras_commander/HdfResultsXsec.py

{ras_commander-0.44.0 → ras_commander-0.45.0}/setup.py

@@ -14,7 +14,7 @@ class CustomBuildPy(build_py):
 
 setup(
     name="ras-commander",
-    version="0.44.0",
+    version="0.45.0",
     packages=["ras_commander"],
     include_package_data=True,
     python_requires='>=3.10',

ras_commander-0.44.0/ras_commander/HdfResultsXsec.py

@@ -1,237 +0,0 @@
-"""
-Class: HdfResultsXsec
-
-Attribution: A substantial amount of code in this file is sourced or derived 
-from the https://github.com/fema-ffrd/rashdf library, 
-released under MIT license and Copyright (c) 2024 fema-ffrd
-
-The file has been forked and modified for use in RAS Commander.
-"""
-
-import h5py
-import numpy as np
-import pandas as pd
-from pathlib import Path
-from typing import Union, Optional, List
-from .HdfBase import HdfBase
-from .HdfUtils import HdfUtils
-from .Decorators import standardize_input, log_call
-from .LoggingConfig import setup_logging, get_logger
-import xarray as xr
-
-logger = get_logger(__name__)
-
-
-class HdfResultsXsec:
-    """
-    A class for handling cross-section results from HEC-RAS HDF files.
-
-    This class provides methods to extract and process steady flow simulation results
-    for cross-sections, including water surface elevations, flow rates, energy grades,
-    and additional parameters such as encroachment stations and velocities.
-
-    The class relies on the HdfBase and HdfUtils classes for core HDF file operations
-    and utility functions.
-
-    Attributes:
-        None
-
-    Methods:
-        steady_profile_xs_output: Extract steady profile cross-section output for a specified variable.
-        cross_sections_wsel: Get water surface elevation data for cross-sections.
-        cross_sections_flow: Get flow data for cross-sections.
-        cross_sections_energy_grade: Get energy grade data for cross-sections.
-        cross_sections_additional_enc_station_left: Get left encroachment station data for cross-sections.
-        cross_sections_additional_enc_station_right: Get right encroachment station data for cross-sections.
-        cross_sections_additional_area_total: Get total ineffective area data for cross-sections.
-        cross_sections_additional_velocity_total: Get total velocity data for cross-sections.
-    """
-
-    @staticmethod
-    @standardize_input(file_type='plan_hdf')
-    def steady_profile_xs_output(hdf_path: Path, var: str, round_to: int = 2) -> pd.DataFrame:
-        """
-        Create a DataFrame from steady cross section results based on the specified variable.
-
-        Parameters:
-        ----------
-        hdf_path : Path
-            Path to the HEC-RAS plan HDF file.
-        var : str
-            The variable to extract from the steady cross section results.
-        round_to : int, optional
-            Number of decimal places to round the results to (default is 2).
-
-        Returns:
-        -------
-        pd.DataFrame
-            DataFrame containing the steady cross section results for the specified variable.
-        """
-        XS_STEADY_OUTPUT_ADDITIONAL = [
-            "Additional Encroachment Station Left",
-            "Additional Encroachment Station Right",
-            "Additional Area Ineffective Total",
-            "Additional Velocity Total",
-        ]
-                
-        try:
-            with h5py.File(hdf_path, 'r') as hdf_file:
-                # Determine the correct path based on the variable
-                if var in XS_STEADY_OUTPUT_ADDITIONAL:
-                    path = f"/Results/Steady/Cross Sections/Additional Output/{var}"
-                else:
-                    path = f"/Results/Steady/Cross Sections/{var}"
-                
-                # Check if the path exists in the HDF file
-                if path not in hdf_file:
-                    return pd.DataFrame()
-
-                # Get the profile names
-                profiles = HdfBase.steady_flow_names(hdf_path)
-                
-                # Extract the steady data
-                steady_data = hdf_file[path]
-                
-                # Create a DataFrame with profiles as index
-                df = pd.DataFrame(steady_data, index=profiles)
-                
-                # Transpose the DataFrame and round values
-                df_t = df.T.copy()
-                for p in profiles:
-                    df_t[p] = df_t[p].apply(lambda x: round(x, round_to))
-
-                return df_t
-        except Exception as e:
-            HdfUtils.logger.error(f"Failed to get steady profile cross section output: {str(e)}")
-            return pd.DataFrame()
-
-    @staticmethod
-    @standardize_input(file_type='plan_hdf')
-    def cross_sections_wsel(hdf_path: Path) -> pd.DataFrame:
-        """
-        Return the water surface elevation information for each 1D Cross Section.
-
-        Parameters:
-        ----------
-        hdf_path : Path
-            Path to the HEC-RAS plan HDF file.
-
-        Returns:
-        -------
-        pd.DataFrame
-            A DataFrame containing the water surface elevations for each cross section and event.
-        """
-        return HdfResultsXsec.steady_profile_xs_output(hdf_path, "Water Surface")
-
-    @staticmethod
-    @standardize_input(file_type='plan_hdf')
-    def cross_sections_flow(hdf_path: Path) -> pd.DataFrame:
-        """
-        Return the Flow information for each 1D Cross Section.
-
-        Parameters:
-        ----------
-        hdf_path : Path
-            Path to the HEC-RAS plan HDF file.
-
-        Returns:
-        -------
-        pd.DataFrame
-            A DataFrame containing the flow for each cross section and event.
-        """
-        return HdfResultsXsec.steady_profile_xs_output(hdf_path, "Flow")
-
-    @staticmethod
-    @standardize_input(file_type='plan_hdf')
-    def cross_sections_energy_grade(hdf_path: Path) -> pd.DataFrame:
-        """
-        Return the energy grade information for each 1D Cross Section.
-
-        Parameters:
-        ----------
-        hdf_path : Path
-            Path to the HEC-RAS plan HDF file.
-
-        Returns:
-        -------
-        pd.DataFrame
-            A DataFrame containing the energy grade for each cross section and event.
-        """
-        return HdfResultsXsec.steady_profile_xs_output(hdf_path, "Energy Grade")
-
-    @staticmethod
-    @standardize_input(file_type='plan_hdf')
-    def cross_sections_additional_enc_station_left(hdf_path: Path) -> pd.DataFrame:
-        """
-        Return the left side encroachment information for a floodway plan hdf.
-
-        Parameters:
-        ----------
-        hdf_path : Path
-            Path to the HEC-RAS plan HDF file.
-
-        Returns:
-        -------
-        pd.DataFrame
-            A DataFrame containing the cross sections left side encroachment stations.
-        """
-        return HdfResultsXsec.steady_profile_xs_output(
-            hdf_path, "Encroachment Station Left"
-        )
-
-    @staticmethod
-    @standardize_input(file_type='plan_hdf')
-    def cross_sections_additional_enc_station_right(hdf_path: Path) -> pd.DataFrame:
-        """
-        Return the right side encroachment information for a floodway plan hdf.
-
-        Parameters:
-        ----------
-        hdf_path : Path
-            Path to the HEC-RAS plan HDF file.
-
-        Returns:
-        -------
-        pd.DataFrame
-            A DataFrame containing the cross sections right side encroachment stations.
-        """
-        return HdfResultsXsec.steady_profile_xs_output(
-            hdf_path, "Encroachment Station Right"
-        )
-
-    @staticmethod
-    @standardize_input(file_type='plan_hdf')
-    def cross_sections_additional_area_total(hdf_path: Path) -> pd.DataFrame:
-        """
-        Return the 1D cross section area for each profile.
-
-        Parameters:
-        ----------
-        hdf_path : Path
-            Path to the HEC-RAS plan HDF file.
-
-        Returns:
-        -------
-        pd.DataFrame
-            A DataFrame containing the wet area inside the cross sections.
-        """
-        return HdfResultsXsec.steady_profile_xs_output(hdf_path, "Area Ineffective Total")
-
-    @staticmethod
-    @standardize_input(file_type='plan_hdf')
-    def cross_sections_additional_velocity_total(hdf_path: Path) -> pd.DataFrame:
-        """
-        Return the 1D cross section velocity for each profile.
-
-        Parameters:
-        ----------
-        hdf_path : Path
-            Path to the HEC-RAS plan HDF file.
-
-        Returns:
-        -------
-        pd.DataFrame
-            A DataFrame containing the velocity inside the cross sections.
-        """
-        return HdfResultsXsec.steady_profile_xs_output(hdf_path, "Velocity Total")
-