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

ras_commander/HdfResultsXsec.py

@@ -1,17 +1,28 @@
+"""
+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
-from pathlib import Path
-from typing import Union, Optional, List
+import xarray as xr
+
 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
+from .LoggingConfig import get_logger
 
 logger = get_logger(__name__)
 
-
 class HdfResultsXsec:
     """
     A class for handling cross-section results from HEC-RAS HDF files.
@@ -225,3 +236,208 @@ class HdfResultsXsec:
         """
         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/HdfStruc.py

@@ -1,3 +1,12 @@
+"""
+Class: HdfStruc
+
+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 typing import Dict, Any, List, Union
 from pathlib import Path
 import h5py

ras_commander/HdfUtils.py

@@ -1,3 +1,12 @@
+"""
+Class: HdfUtils
+
+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 logging
 from pathlib import Path
 import h5py
@@ -338,30 +347,27 @@ class HdfUtils:
         return parsed_dt
 
     @staticmethod
-    def _ras_timesteps_to_datetimes(timesteps: np.ndarray, start_time: datetime, time_unit: str, round_to: str = "0.1 s") -> List[datetime]:
+    def _ras_timesteps_to_datetimes(timesteps: np.ndarray, start_time: datetime, time_unit: str = "days", round_to: str = "100ms") -> pd.DatetimeIndex:
         """
-        Convert an array of RAS timesteps into a list of datetime objects.
+        Convert RAS timesteps to datetime objects.
 
         Args:
-            timesteps (np.ndarray): An array of RAS timesteps.
-            start_time (datetime): The start time of the simulation.
-            time_unit (str): The time unit of the timesteps.
-            round_to (str): The time unit to round the datetimes to. Default is "0.1 s".
+            timesteps (np.ndarray): Array of timesteps.
+            start_time (datetime): Start time of the simulation.
+            time_unit (str): Unit of the timesteps. Default is "days".
+            round_to (str): Frequency string to round the times to. Default is "100ms" (100 milliseconds).
 
         Returns:
-            List[datetime]: A list of datetime objects corresponding to the timesteps.
-
-        Note:
-            The `round_to` parameter uses Pandas time string notation. For example:
-            - "0.1 s" means round to the nearest 0.1 seconds
-            - "1 s" means round to the nearest second
-            - "1 min" means round to the nearest minute
-            For more options, see Pandas documentation on time string notation.
-        """
-        return [
-            start_time + pd.Timedelta(timestep, unit=time_unit).round(round_to)
-            for timestep in timesteps.astype(np.float64)
-        ]
+            pd.DatetimeIndex: DatetimeIndex of converted and rounded datetimes.
+        """
+        if time_unit == "days":
+            datetimes = start_time + pd.to_timedelta(timesteps, unit='D')
+        elif time_unit == "hours":
+            datetimes = start_time + pd.to_timedelta(timesteps, unit='H')
+        else:
+            raise ValueError(f"Unsupported time unit: {time_unit}")
+
+        return pd.DatetimeIndex(datetimes).round(round_to)
 
     @staticmethod
     def _hdf5_attrs_to_dict(attrs: Union[h5py.AttributeManager, Dict], prefix: Optional[str] = None) -> Dict:

ras_commander/HdfXsec.py

@@ -1,3 +1,13 @@
+"""
+Class: HdfXsec
+
+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/__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.43.0.dist-info → ras_commander-0.45.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ras-commander
-Version: 0.43.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
@@ -62,7 +62,7 @@ Create a virtual environment with conda or venv (ask ChatGPT if you need help)
 In your virtual environment, install ras-commander using pip:
 ```
 pip install h5py numpy pandas requests tqdm scipy
-pip install ras-commander
+pip install --upgrade ras-commander
 ```
 
 If you have dependency issues with pip (especially if you have errors with numpy), try clearing your local pip packages 'C:\Users\your_username\AppData\Roaming\Python\' and then creating a new virtual environment.  
@@ -299,6 +299,13 @@ These acknowledgments recognize the contributions and inspirations that have hel
 4. [HEC-Commander Tools](https://github.com/billk-FM/HEC-Commander) - Inspiration and initial code base for the development of RAS Commander.
 
 
+## Official RAS Commander AI-Generated Songs:
+
+[No More Wait and See (Bluegrass)](https://suno.com/song/16889f3e-50f1-4afe-b779-a41738d7617a)  
+
+[No More Wait and See (Cajun Zydeco)](https://suno.com/song/4441c45d-f6cd-47b9-8fbc-1f7b277ee8ed)  
+
+
 ## Contact
 
 For questions, suggestions, or support, please contact:

ras_commander-0.45.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+ras_commander/Decorators.py,sha256=i5AEQbe7JeI8Y3O_dQ5OO4Ab0KO5SiZTiysFBGxqTRU,4978
+ras_commander/HdfBase.py,sha256=HV5ccV9QH2lz4ZRYqK2d7_S833cTSUcostzxxSPb4O4,7129
+ras_commander/HdfBndry.py,sha256=LWaDMHeo0V_VOpx7D9q7W_0WvWsD6NQThiSLYPY8ApE,20761
+ras_commander/HdfMesh.py,sha256=JKWn6S-FcdFs3fZQMQ8mkIEIFFxUdVjWb5r7jAh3ujw,12668
+ras_commander/HdfPipe.py,sha256=agGhMNeANi92eS62CEoaPDimS0I0yGoAoMv1c8YAIk4,9432
+ras_commander/HdfPlan.py,sha256=nt1Q03cPNX_yVX0mOUqeWGPicqtusUnuBSTcBw8n0Vg,6967
+ras_commander/HdfPump.py,sha256=8mBfFg0epaq74txDyUfBPkWqzvRQCb8OojEgDGCridM,9416
+ras_commander/HdfResultsMesh.py,sha256=Ke6HSpdKBd-TUa0QIuMaxhyj--lfuQGlMDlDuk2qrd8,28064
+ras_commander/HdfResultsPlan.py,sha256=-4tTMLiSkuOs3pKn7sA_1RoGmBxaG8jMUJ9qvVlc2Q0,17299
+ras_commander/HdfResultsXsec.py,sha256=4BHIX-VTfkh1YwIUJDZpnnz_-wGctOJO2XVCTsiUXDs,16393
+ras_commander/HdfStruc.py,sha256=NNTSwUQmLMLn8SPyrLIKXaUaqKavTos_TDDB6Mja7-4,5595
+ras_commander/HdfUtils.py,sha256=dUU9QkNO-FhaCjD_TEOv_FNNrZI3TUOQ6QjSiXrJGSc,18403
+ras_commander/HdfXsec.py,sha256=ccJ-GAVKwS2Z-k6CCWAYvw974xCBTTF-5Hh1CnikVG4,11562
+ras_commander/LoggingConfig.py,sha256=5bYd_5KMlf81bXsiu2mABBlw0USMhcu5uRv8DIYJSFE,2317
+ras_commander/RasCmdr.py,sha256=qZtdvwQnZxOjhU3pZWRCJ80aH5QWOJD_F7P_05geSHA,25020
+ras_commander/RasExamples.py,sha256=FDit6FWzTQbv42Xx0gtSJB17HDeol_eykxV0qVpnwIk,16688
+ras_commander/RasGeo.py,sha256=x7eFvUQ_dPZxAVq2Gw_GIRzn-Cf7DLKZDTwk1fjrkf8,5395
+ras_commander/RasGpt.py,sha256=1Nitlf5QyeBQo8Q8I8pJKaTtQ0GdsBQA71LIKUAOycA,839
+ras_commander/RasPlan.py,sha256=_0EjxQnamd9FhzzKlYNqJ3chv2bvxfk0DXEwfHntXFo,40287
+ras_commander/RasPrj.py,sha256=ePLcPNcKVMgijvJKkJIWwQslQi2D6zq2UTW-8XCFmto,36159
+ras_commander/RasUnsteady.py,sha256=oBVC9QFQMrSx8LY2Cb1CjUyCQEUoIEnEuVJsATYiVYs,4649
+ras_commander/RasUtils.py,sha256=NBMxTHWHoTH2MJzqJ0y1_00fgKSS1GnNuEikwZ3Pqzs,34153
+ras_commander/__init__.py,sha256=8sg6T5I_uAqGe2pInrMnBrhS8NZbfnF7Pp7uwzQOqIo,1722
+ras_commander-0.45.0.dist-info/LICENSE,sha256=_pbd6qHnlsz1iQ-ozDW_49r86BZT6CRwO2iBtw0iN6M,457
+ras_commander-0.45.0.dist-info/METADATA,sha256=Y7H1Fq4aG4C2ujRl6VkjxBLOaNZUzX1X7gNd5UJDU7s,15935
+ras_commander-0.45.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+ras_commander-0.45.0.dist-info/top_level.txt,sha256=i76S7eKLFC8doKcXDl3aiOr9RwT06G8adI6YuKbQDaA,14
+ras_commander-0.45.0.dist-info/RECORD,,

ras_commander-0.43.0.dist-info/RECORD

@@ -1,26 +0,0 @@
-ras_commander/Decorators.py,sha256=i5AEQbe7JeI8Y3O_dQ5OO4Ab0KO5SiZTiysFBGxqTRU,4978
-ras_commander/HdfBase.py,sha256=xAaQdHa80EAjhjjp2UMLIFzWf7xVncunj0bxbPJciFg,6863
-ras_commander/HdfBndry.py,sha256=dXyM9yVEyNcvCJFsCr5R6XY1V8LnDUQTbScnkeqSuuI,20469
-ras_commander/HdfMesh.py,sha256=EETuwOqDnmus1tbATmfANq5MLoN6GTw6K9IAm5vGqx0,12386
-ras_commander/HdfPlan.py,sha256=gj34nSlzXOxa5EPYNYoL9ocWa83lzUuMOMl7kvKzaIk,6674
-ras_commander/HdfResultsMesh.py,sha256=vFR3DpyS55W_QhgCypYKq6bRFwjIBc8D4ql9ZISn9RY,28295
-ras_commander/HdfResultsPlan.py,sha256=htRCxZh26_fwgZtJt5USifcapUg0WRChsZRWzgC4bMU,17141
-ras_commander/HdfResultsXsec.py,sha256=nxj0WUA149EoB_WjlIqlGyb3QJt4LMc32X7unsJM62A,8126
-ras_commander/HdfStruc.py,sha256=P9rEfmvqlD1CgJ7OFzBm4ST3K-5IrxmrON6PwT68yMg,5303
-ras_commander/HdfUtils.py,sha256=94ojuG7FV_IT9KjYIBS_zL8LqdmVi1s0eppXnY-_338,18274
-ras_commander/HdfXsec.py,sha256=moPbWcGhoIK5xEKoFvebTOKNlcwXAmQtQVZW9DTlhzQ,11269
-ras_commander/LoggingConfig.py,sha256=5bYd_5KMlf81bXsiu2mABBlw0USMhcu5uRv8DIYJSFE,2317
-ras_commander/RasCmdr.py,sha256=qZtdvwQnZxOjhU3pZWRCJ80aH5QWOJD_F7P_05geSHA,25020
-ras_commander/RasExamples.py,sha256=FDit6FWzTQbv42Xx0gtSJB17HDeol_eykxV0qVpnwIk,16688
-ras_commander/RasGeo.py,sha256=x7eFvUQ_dPZxAVq2Gw_GIRzn-Cf7DLKZDTwk1fjrkf8,5395
-ras_commander/RasGpt.py,sha256=1Nitlf5QyeBQo8Q8I8pJKaTtQ0GdsBQA71LIKUAOycA,839
-ras_commander/RasPlan.py,sha256=_0EjxQnamd9FhzzKlYNqJ3chv2bvxfk0DXEwfHntXFo,40287
-ras_commander/RasPrj.py,sha256=ePLcPNcKVMgijvJKkJIWwQslQi2D6zq2UTW-8XCFmto,36159
-ras_commander/RasUnsteady.py,sha256=oBVC9QFQMrSx8LY2Cb1CjUyCQEUoIEnEuVJsATYiVYs,4649
-ras_commander/RasUtils.py,sha256=NBMxTHWHoTH2MJzqJ0y1_00fgKSS1GnNuEikwZ3Pqzs,34153
-ras_commander/__init__.py,sha256=3MuobRXVEQNvoGwf9AlbvuJg8meni3eWw_JZMFOuMt4,1630
-ras_commander-0.43.0.dist-info/LICENSE,sha256=_pbd6qHnlsz1iQ-ozDW_49r86BZT6CRwO2iBtw0iN6M,457
-ras_commander-0.43.0.dist-info/METADATA,sha256=yMVLfZpTzUgJVVR-njq5izBxTcgwBHVVr6238PHvG2M,15671
-ras_commander-0.43.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-ras_commander-0.43.0.dist-info/top_level.txt,sha256=i76S7eKLFC8doKcXDl3aiOr9RwT06G8adI6YuKbQDaA,14
-ras_commander-0.43.0.dist-info/RECORD,,