ras-commander 0.43.0__py3-none-any.whl → 0.45.0__py3-none-any.whl

ras_commander/HdfBase.py

@@ -1,3 +1,12 @@
+"""
+Class: HdfBase
+
+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 re
 from datetime import datetime, timedelta
 import h5py
@@ -7,7 +16,6 @@ import xarray as xr  # Added import for xarray
 from typing import List, Tuple, Union, Optional, Dict
 from pathlib import Path
 import logging
-import dask.array as da
 
 from .HdfUtils import HdfUtils
 from .Decorators import standardize_input, log_call

ras_commander/HdfBndry.py

@@ -1,3 +1,12 @@
+"""
+Class: HdfBndry
+
+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 Dict, List, Optional, Union, Any
 import h5py

ras_commander/HdfMesh.py

@@ -1,3 +1,12 @@
+"""
+Class: HdfMesh
+
+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
 import h5py
 import numpy as np

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/HdfPlan.py

@@ -1,3 +1,13 @@
+"""
+Class: HdfPlan
+
+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 pandas as pd
 from datetime import datetime

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