ras-commander 0.48.0__py3-none-any.whl → 0.49.0__py3-none-any.whl

ras_commander/RasPrj.py

@@ -37,6 +37,40 @@ Example:
         
         logger.debug("Additional debug information")
         # Function logic here
+        
+-----
+
+All of the methods in this class are class methods and are designed to be used with instances of the class.
+
+List of Functions in RasPrj:    
+- initialize()
+- _load_project_data()
+- _get_geom_file_for_plan()
+- _parse_plan_file()
+- _parse_unsteady_file()
+- _get_prj_entries()
+- _parse_boundary_condition()
+- is_initialized (property)
+- check_initialized()
+- find_ras_prj()
+- get_project_name()
+- get_prj_entries()
+- get_plan_entries()
+- get_flow_entries()
+- get_unsteady_entries()
+- get_geom_entries()
+- get_hdf_entries()
+- print_data()
+- get_plan_value()
+- get_boundary_conditions()
+        
+Functions in RasPrj that are not part of the class:        
+- init_ras_project()
+- get_ras_exe()
+
+        
+        
+        
 """
 import os
 import re

ras_commander/RasToGo.py

@@ -1,6 +1,22 @@
 """
 RasToGo module provides functions to interface HEC-RAS with go-consequences.
 This module helps prepare and format RAS data for use with go-consequences.
+
+
+-----
+
+All of the methods in this class are static and are designed to be used without instantiation.
+
+List of Functions in RasToGo:
+
+TO BE IMPLEMENTED: 
+- Adding stored maps in rasmaapper for a results file
+- Editing the terrain name for stored maps, so that a reduced resolution terrain can be used for mapping
+- Re-computing specific plans using the floodplain mapping option to generate stored maps
+- Using the stored map output to call go-consequences and compute damages
+- Comparisons of go-consequences outputs based on RAS plan number
+    - include optional argument with polygons defining areas of interest
+
 """
 
 import logging

ras_commander/RasUnsteady.py

@@ -21,6 +21,21 @@ Example:
     def my_function():
         logger.debug("Additional debug information")
         # Function logic here
+        
+-----
+
+All of the methods in this class are static and are designed to be used without instantiation.
+
+List of Functions in RasUnsteady:
+- update_flow_title()
+- update_restart_settings()
+- extract_boundary_and_tables()
+- print_boundaries_and_tables()
+- identify_tables()
+- parse_fixed_width_table()
+- extract_tables()
+- write_table_to_file()
+        
 """
 import os
 from pathlib import Path

ras_commander/RasUtils.py

@@ -20,6 +20,37 @@ Example:
     def my_function():
         logger.debug("Additional debug information")
         # Function logic here
+        
+-----
+
+All of the methods in this class are static and are designed to be used without instantiation.
+
+List of Functions in RasUtils:
+- create_directory()
+- find_files_by_extension()
+- get_file_size()
+- get_file_modification_time()
+- get_plan_path()
+- remove_with_retry()
+- update_plan_file()
+- check_file_access()
+- convert_to_dataframe()
+- save_to_excel()
+- calculate_rmse()
+- calculate_percent_bias()
+- calculate_error_metrics()
+- update_file()
+- get_next_number()
+- clone_file()
+- update_project_file()
+- decode_byte_strings()
+- perform_kdtree_query()
+- find_nearest_neighbors()
+- consolidate_dataframe()
+- find_nearest_value()
+- horizontal_distance()
+    
+        
 """
 import os
 from pathlib import Path

ras_commander/__init__.py

@@ -36,6 +36,12 @@ from .HdfUtils import HdfUtils
 from .HdfXsec import HdfXsec
 from .HdfPump import HdfPump
 from .HdfPipe import HdfPipe
+from .HdfInfiltration import HdfInfiltration
+from .RasMapper import RasMapper
+
+# Import plotting classes
+from .HdfPlot import HdfPlot
+from .HdfResultsPlot import HdfResultsPlot
 
 # Define __all__ to specify what should be imported when using "from ras_commander import *"
 __all__ = [
@@ -51,6 +57,10 @@ __all__ = [
     "HdfXsec",
     "HdfPump",
     "HdfPipe",
+    "HdfPlot",
+    "HdfResultsPlot",
+    "HdfInfiltration",
+    "RasMapper",
     "standardize_input",
     "ras",
     "init_ras_project",

{ras_commander-0.48.0.dist-info → ras_commander-0.49.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ras-commander
-Version: 0.48.0
+Version: 0.49.0
 Summary: A Python library for automating HEC-RAS operations
 Home-page: https://github.com/billk-FM/ras-commander
 Author: William M. Katzenmeyer
@@ -118,26 +118,56 @@ Certainly! I'll provide you with an updated Key Components section and Project O
 - `RasUnsteady`: Manages unsteady flow file operations
 - `RasUtils`: Contains utility functions for file operations and data management
 - `RasExamples`: Manages and loads HEC-RAS example projects
-- `RasHdf`: Provides utilities for working with HDF files in HEC-RAS projects
+
+### New Components:
+- `HdfBase`: Core functionality for HDF file operations
+- `HdfBndry`: Enhanced boundary condition handling
+- `HdfMesh`: Comprehensive mesh data management
+- `HdfPlan`: Plan data extraction and analysis
+- `HdfResultsMesh`: Advanced mesh results processing
+- `HdfResultsPlan`: Plan results analysis
+- `HdfResultsXsec`: Cross-section results processing
+- `HdfStruc`: Structure data management
+- `HdfPipe`: Pipe network analysis tools
+- `HdfPump`: Pump station analysis capabilities
+- `HdfFluvialPluvial`: Fluvial-pluvial boundary analysis
+- `RasMapper`: RASMapper interface
+- `RasToGo`: Go-Consequences integration
+- `HdfPlot` & `HdfResultsPlot`: Specialized plotting utilities
+
+## Project Organization Diagram
 
 ## Project Organization Diagram
 
 ```
 ras_commander
-├── .github
-│   └── workflows
-│       └── python-package.yml
 ├── ras_commander
 │   ├── __init__.py
 │   ├── _version.py
+│   ├── Decorators.py
+│   ├── LoggingConfig.py
 │   ├── RasCmdr.py
 │   ├── RasExamples.py
 │   ├── RasGeo.py
-│   ├── RasHdf.py
 │   ├── RasPlan.py
 │   ├── RasPrj.py
 │   ├── RasUnsteady.py
-│   └── RasUtils.py
+│   ├── RasUtils.py
+│   ├── RasToGo.py
+│   ├── RasGpt.py
+│   ├── HdfBase.py
+│   ├── HdfBndry.py
+│   ├── HdfMesh.py
+│   ├── HdfPlan.py
+│   ├── HdfResultsMesh.py
+│   ├── HdfResultsPlan.py
+│   ├── HdfResultsXsec.py
+│   ├── HdfStruc.py
+│   ├── HdfPipe.py
+│   ├── HdfPump.py
+│   ├── HdfFluvialPluvial.py
+│   ├── HdfPlot.py
+│   └── HdfResultsPlot.py
 ├── examples
 │   ├── 01_project_initialization.py
 │   ├── 02_plan_operations.py
@@ -236,10 +266,45 @@ plan_number = "01"
 runtime_data = RasHdf.get_runtime_data(plan_number, ras_object=custom_ras)
 print(runtime_data)
 ```
-
 This class simplifies the process of extracting and analyzing data from HEC-RAS HDF output files, supporting tasks such as post-processing and result visualization.
 
 
+### Infrastructure Analysis
+```python
+from ras_commander import HdfPipe, HdfPump
+
+# Analyze pipe network
+pipe_network = HdfPipe.get_pipe_network(hdf_path)
+conduits = HdfPipe.get_pipe_conduits(hdf_path)
+
+# Analyze pump stations
+pump_stations = HdfPump.get_pump_stations(hdf_path)
+pump_performance = HdfPump.get_pump_station_summary(hdf_path)
+```
+
+### Advanced Results Analysis
+```python
+from ras_commander import HdfResultsMesh
+
+# Get maximum water surface and velocity
+max_ws = HdfResultsMesh.get_mesh_max_ws(hdf_path)
+max_vel = HdfResultsMesh.get_mesh_max_face_v(hdf_path)
+
+# Visualize results
+from ras_commander import HdfResultsPlot
+HdfResultsPlot.plot_results_max_wsel(max_ws)
+```
+
+### Fluvial-Pluvial Analysis
+```python
+from ras_commander import HdfFluvialPluvial
+
+boundary = HdfFluvialPluvial.calculate_fluvial_pluvial_boundary(
+    hdf_path,
+    delta_t=12  # Time threshold in hours
+)
+
+
 ## Documentation
 
 For detailed usage instructions and API documentation, please refer to the [Comprehensive Library Guide](Comprehensive_Library_Guide.md).

ras_commander-0.49.0.dist-info/RECORD

@@ -0,0 +1,34 @@
+ras_commander/Decorators.py,sha256=M5r5cHz_yy9YTHNEoytO9uwWbv_S-YYUk2QHNamJJJs,5848
+ras_commander/HdfBase.py,sha256=bJtSWdDUP4MYJ8QgkcixBEDFMSlslUdmVFHZxWMGMDM,11603
+ras_commander/HdfBndry.py,sha256=gcNr22vHNjEiWYigz-4aKUEYUi__3bRl4AeRAQQEmjs,12553
+ras_commander/HdfFluvialPluvial.py,sha256=V6RGpKmnX5E6XzAJPcexcPtC2Qfy56XpJi_Vq4KEV7o,10243
+ras_commander/HdfInfiltration.py,sha256=QVigQJjYeQNutbazGHhbTmEuIVCb9gIb2f4yM-wyUtQ,15269
+ras_commander/HdfMesh.py,sha256=Yyom3i46AQFqI9cvhUyc5vh_g98aKAAsAjx7akuzsXw,18299
+ras_commander/HdfPipe.py,sha256=m-yvPL2GIP23NKt2tcwzOlS7khvgcDPGAshlTPMUAeI,32154
+ras_commander/HdfPlan.py,sha256=NW6g2kS74y44Ci1P9iMo7IKUfR0eYOaJn1QbzsRM1co,10415
+ras_commander/HdfPlot.py,sha256=m4hbVkRbLW5a515jnM-iHSt5CLgtLSn5yxSpzRmgCGk,3337
+ras_commander/HdfPump.py,sha256=Vc2ff16kRISR7jwtnaAqxI0p-gfBSuZKzR3rQbBLQoE,12951
+ras_commander/HdfResultsMesh.py,sha256=RIwifjvVU3DuO4SpRvPsse7io9TpiJljAuNJe_K82wM,31316
+ras_commander/HdfResultsPlan.py,sha256=HoN3wvhj1wtkW-M20UHH9skntDqEvJEgeYeO_QBLF2w,11974
+ras_commander/HdfResultsPlot.py,sha256=ylzfT78CfgoDO0XAlRwlgMNRzvNQYBMn9eyXyBfjv_w,7660
+ras_commander/HdfResultsXsec.py,sha256=-P7nXnbjOLAeUnrdSC_lJQSfzrlWKmDF9Z5gEjmxbJY,13031
+ras_commander/HdfStruc.py,sha256=yzD4_eZLgwZDS3GdYVWqd85jRpdlRdVdbHHfPYTmwjA,12703
+ras_commander/HdfUtils.py,sha256=AbfV5RwbFyNR1SFGKO_izmVtRnDx68u_4wep5FK14xU,14814
+ras_commander/HdfXsec.py,sha256=uuogrJjRFytNHxmluQVuB57X1lILo1Y15wtc_VaHMX8,26809
+ras_commander/LoggingConfig.py,sha256=5bYd_5KMlf81bXsiu2mABBlw0USMhcu5uRv8DIYJSFE,2317
+ras_commander/RasCmdr.py,sha256=N2PI5n0P3ClLUPOPNcONJHGJYF-fIU5o0GXwHv4VATE,25271
+ras_commander/RasExamples.py,sha256=eYlRKryCG88FN5p23TnA1-E2Bxuaz3OxjdHPHJSqdB8,17006
+ras_commander/RasGeo.py,sha256=M0sVNKlWmmbve8iMXLWq25WgbxqLWBo7_1oDg_rALzU,5607
+ras_commander/RasGpt.py,sha256=N_7p2nucWrBBXdB2k2ZKvOeOdXNmFD9dIY3W7_5i5nw,1206
+ras_commander/RasMapper.py,sha256=A7xupixCmgXFiSfQs3oWBMBstrO8XcxieMeZWKTcbPQ,3271
+ras_commander/RasPlan.py,sha256=jt0adLtwGjrKC90uuBXYgHpVyV3cKgD1Q_zkKiI04fc,52742
+ras_commander/RasPrj.py,sha256=QLt8f__M0jguzva7C2J0uNFLR7v8t_MIeZpIXcCN4Tw,36851
+ras_commander/RasToGo.py,sha256=TKujfaV1xQhFaOddF4g2ogGy6ky-CLlfelSMPD2J3Nk,1223
+ras_commander/RasUnsteady.py,sha256=NWZbmB3-HT0W00K4-zxFN9OF8H_HlOY64nM72sHicWg,31154
+ras_commander/RasUtils.py,sha256=P2-aBL61kdRINsjnBpstZVD6VVc7hI_D3RUXqr6ldmc,34863
+ras_commander/__init__.py,sha256=vhnZQaejmyFVFP5fcYxAc4A562o8KFcnZNkcY6J5xwY,2068
+ras_commander-0.49.0.dist-info/LICENSE,sha256=_pbd6qHnlsz1iQ-ozDW_49r86BZT6CRwO2iBtw0iN6M,457
+ras_commander-0.49.0.dist-info/METADATA,sha256=EAK_gweDEyFXD8yvAFAywr33gxm7pFrGh37pdTrCrXU,18278
+ras_commander-0.49.0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+ras_commander-0.49.0.dist-info/top_level.txt,sha256=i76S7eKLFC8doKcXDl3aiOr9RwT06G8adI6YuKbQDaA,14
+ras_commander-0.49.0.dist-info/RECORD,,

ras_commander-0.48.0.dist-info/RECORD

@@ -1,30 +0,0 @@
-ras_commander/Decorators.py,sha256=i5AEQbe7JeI8Y3O_dQ5OO4Ab0KO5SiZTiysFBGxqTRU,4978
-ras_commander/HdfBase.py,sha256=HV5ccV9QH2lz4ZRYqK2d7_S833cTSUcostzxxSPb4O4,7129
-ras_commander/HdfBndry.py,sha256=29SAcn-LGf3QiNCeRmlT7JsGI94Dwl9NMm-zHNBuXlA,20752
-ras_commander/HdfFluvialPluvial.py,sha256=5OwYYEoLRJ4gfzi4kOBPO9_LVI_OyqW-Z8Jr7POOr34,13965
-ras_commander/HdfMesh.py,sha256=lNzEN7npA4KXUB9ZLyCMRk-EuL0oPD6J5MPZYamV7xU,14657
-ras_commander/HdfPipe.py,sha256=StL7D5hgdknzwS8VRSd9Rg_U9VOstepDvYvquLYCLOs,34348
-ras_commander/HdfPlan.py,sha256=DDnkMZ4Px4_4Netb7rLyxpDG1N-C742Yce4fDmNZAVo,6977
-ras_commander/HdfPump.py,sha256=LPQPjOL6dWpJBW2F9pQVzNyqQL1XvNvUmjtf_hDygV4,10486
-ras_commander/HdfResultsMesh.py,sha256=BLKCarZES9t2_L0lbPnCeVtaF2MhFH-ZRw6Kjsl-fuY,31264
-ras_commander/HdfResultsPlan.py,sha256=-4tTMLiSkuOs3pKn7sA_1RoGmBxaG8jMUJ9qvVlc2Q0,17299
-ras_commander/HdfResultsXsec.py,sha256=KOmsGlkZ2mr0aN55ZFu4T119MiMtLb5i5Sd9CMhHvj8,10516
-ras_commander/HdfStruc.py,sha256=zT5cgGKw83QnBTXqfHO2BkKKXV8cJ1A9N8_n7h9ZSJk,11510
-ras_commander/HdfUtils.py,sha256=Qz7uHqQRYPb4N214QU5q6p12i8Z9dhY80bcZUbOIM-s,20384
-ras_commander/HdfXsec.py,sha256=wnqNFD9vQjAHgU5w8FFu9MrJhEZXxeDdg6FLM-B4VLw,26427
-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=fVuWQL6bnRCoHm-WiWv2mWZ8vTsDXn1BxcwUf03ma8s,51276
-ras_commander/RasPrj.py,sha256=Ppmv3Yx_iN1ARKWC_dfSGVhdi4tHIuapDSdLbuAAGLU,36084
-ras_commander/RasToGo.py,sha256=UiUbvpjcAxAkWdSc-9Yywy7eOkGJaTHs24p4cjiL7co,588
-ras_commander/RasUnsteady.py,sha256=4j5Ga5hP8LepgR93uywjUjOEDhznLF7UnNtRmBS5d48,30779
-ras_commander/RasUtils.py,sha256=NBMxTHWHoTH2MJzqJ0y1_00fgKSS1GnNuEikwZ3Pqzs,34153
-ras_commander/__init__.py,sha256=-8mrN9qNbKiK0RfgCJasORkzuIKPHmY6RfYLzZqm2ok,1804
-ras_commander-0.48.0.dist-info/LICENSE,sha256=_pbd6qHnlsz1iQ-ozDW_49r86BZT6CRwO2iBtw0iN6M,457
-ras_commander-0.48.0.dist-info/METADATA,sha256=sEeBUJL0yGQez4hOPSqMr39IWLOzqMK90hLiaVFT45k,16020
-ras_commander-0.48.0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-ras_commander-0.48.0.dist-info/top_level.txt,sha256=i76S7eKLFC8doKcXDl3aiOr9RwT06G8adI6YuKbQDaA,14
-ras_commander-0.48.0.dist-info/RECORD,,