ras-commander 0.34.0__py3-none-any.whl → 0.35.0__py3-none-any.whl

ras_commander/RasPlan.py

@@ -1060,7 +1060,7 @@ class RasPlan:
         Any: The value associated with the specified key
 
         Raises:
-        ValueError: If an invalid key is provided or if the plan file is not found
+        ValueError: If the plan file is not found
         IOError: If there's an error reading the plan file
 
         Available keys and their expected types:
@@ -1086,6 +1086,7 @@ class RasPlan:
         - 'unet_1d_methodology' (str): 1D calculation methodology
         - 'unet_d2_solver_type' (str): 2D solver type
         - 'unet_d2_name' (str): Name of the 2D area
+        - 'run_rasmapper' (int): Flag to run RASMapper for floodplain mapping (-1 for off, 0 for on)
 
         Example:
         >>> computation_interval = RasPlan.get_plan_value("01", "computation_interval")
@@ -1099,11 +1100,11 @@ class RasPlan:
             'geom_file', 'mapping_interval', 'plan_file', 'plan_title', 'program_version',
             'run_htab', 'run_post_process', 'run_sediment', 'run_unet', 'run_wqnet',
             'short_identifier', 'simulation_date', 'unet_d1_cores', 'unet_use_existing_ib_tables',
-            'unet_1d_methodology', 'unet_d2_solver_type', 'unet_d2_name'
+            'unet_1d_methodology', 'unet_d2_solver_type', 'unet_d2_name', 'run_rasmapper'
         }
 
         if key not in valid_keys:
-            raise ValueError(f"Invalid key: {key}. Valid keys are: {', '.join(valid_keys)}")
+            logging.warning(f"Unknown key: {key}. Valid keys are: {', '.join(valid_keys)}\n Add more keys and explanations in get_plan_value() as needed.")
 
         plan_file_path = Path(plan_number_or_path)
         if not plan_file_path.is_file():
@@ -1124,7 +1125,11 @@ class RasPlan:
         else:
             pattern = f"{key.replace('_', ' ').title()}=(.*)"
             match = re.search(pattern, content)
-            return match.group(1).strip() if match else None
+            if match:
+                return match.group(1).strip()
+            else:
+                logging.error(f"Key '{key}' not found in the plan file.")
+                return None
 
     @staticmethod
     def update_plan_value(
@@ -1143,7 +1148,7 @@ class RasPlan:
         ras_object (RasPrj, optional): Specific RAS object to use. If None, uses the global ras instance.
 
         Raises:
-        ValueError: If an invalid key is provided or if the plan file is not found
+        ValueError: If the plan file is not found
         IOError: If there's an error reading or writing the plan file
 
         Note: See the docstring of get_plan_value for a full list of available keys and their types.
@@ -1151,6 +1156,7 @@ class RasPlan:
         Example:
         >>> RasPlan.update_plan_value("01", "computation_interval", "10SEC")
         >>> RasPlan.update_plan_value("/path/to/plan.p01", "run_htab", 1)
+        >>> RasPlan.update_plan_value("01", "run_rasmapper", 0)  # Turn on Floodplain Mapping
         """
         ras_obj = ras_object or ras
         ras_obj.check_initialized()
@@ -1160,11 +1166,11 @@ class RasPlan:
             'geom_file', 'mapping_interval', 'plan_file', 'plan_title', 'program_version',
             'run_htab', 'run_post_process', 'run_sediment', 'run_unet', 'run_wqnet',
             'short_identifier', 'simulation_date', 'unet_d1_cores', 'unet_use_existing_ib_tables',
-            'unet_1d_methodology', 'unet_d2_solver_type', 'unet_d2_name'
+            'unet_1d_methodology', 'unet_d2_solver_type', 'unet_d2_name', 'run_rasmapper'
         }
 
         if key not in valid_keys:
-            raise ValueError(f"Invalid key: {key}. Valid keys are: {', '.join(valid_keys)}")
+            logging.warning(f"Unknown key: {key}. Valid keys are: {', '.join(valid_keys)}")
 
         plan_file_path = Path(plan_number_or_path)
         if not plan_file_path.is_file():
@@ -1203,7 +1209,8 @@ class RasPlan:
                     updated = True
                     break
             if not updated:
-                lines.append(f"{pattern}{value}\n")
+                logging.error(f"Key '{key}' not found in the plan file.")
+                return
 
         try:
             with open(plan_file_path, 'w') as file:

ras_commander/RasPrj.py

@@ -650,6 +650,10 @@ def init_ras_project(ras_project_folder, ras_version, ras_instance=None):
     Avoid mixing use of the global 'ras' object and custom instances to prevent
     confusion and potential bugs.
     """
+    logging.info(f"Initializing project in folder: {ras_project_folder}")
+    logging.info(f"Using ras_instance with id: {id(ras_instance)}")
+    
+
 
     if not Path(ras_project_folder).exists():
         logging.error(f"The specified RAS project folder does not exist: {ras_project_folder}. Please check the path and try again.")
@@ -666,7 +670,8 @@ def init_ras_project(ras_project_folder, ras_version, ras_instance=None):
 
     # Initialize the RasPrj instance
     ras_instance.initialize(ras_project_folder, ras_exe_path)
-
+    
+    logging.info(f"Project initialized. ras_instance project folder: {ras_instance.project_folder}")
     return ras_instance
 
 
@@ -729,4 +734,5 @@ def get_ras_exe(ras_version):
         f"Invalid HEC-RAS version or path: {ras_version}. "
         f"Please provide a valid version number from {ras_version_numbers} "
         "or a full path to the HEC-RAS executable."
-    )
+    )
+    

{ras_commander-0.34.0.dist-info → ras_commander-0.35.0.dist-info}/METADATA

@@ -1,11 +1,12 @@
 Metadata-Version: 2.1
 Name: ras-commander
-Version: 0.34.0
+Version: 0.35.0
 Summary: A Python library for automating HEC-RAS operations
 Home-page: https://github.com/billk-FM/ras-commander
 Author: William M. Katzenmeyer
 Author-email: billk@fenstermaker.com
-Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
@@ -15,9 +16,10 @@ Requires-Dist: pandas>=1.0.0
 Requires-Dist: numpy>=1.18.0
 Requires-Dist: h5py>=3.1.0
 Requires-Dist: requests>=2.25.0
-Requires-Dist: pathlib>=1.0.1
 Requires-Dist: scipy>=1.5.0
 Requires-Dist: matplotlib>=3.3.0
+Requires-Dist: tqdm>=4.50.0
+Requires-Dist: psutil>=5.7.0
 Provides-Extra: dev
 Requires-Dist: pytest>=6.2.0; extra == "dev"
 Requires-Dist: flake8>=3.9.0; extra == "dev"
@@ -116,18 +118,21 @@ results = RasCmdr.compute_parallel(
 RasPlan.set_geom("01", "02")
 ```
 
+Certainly! I'll provide you with an updated Key Components section and Project Organization diagram based on the current structure of the ras-commander library.
+
 ## Key Components
 
-- `RasPrj`: Manages HEC-RAS projects
+- `RasPrj`: Manages HEC-RAS projects, handling initialization and data loading
 - `RasCmdr`: Handles execution of HEC-RAS simulations
 - `RasPlan`: Provides functions for modifying and updating plan files
 - `RasGeo`: Handles operations related to geometry files
 - `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
 
 ## Project Organization Diagram
+
 ```
 ras_commander
 ├── .github
@@ -135,9 +140,11 @@ ras_commander
 │       └── python-package.yml
 ├── ras_commander
 │   ├── __init__.py
+│   ├── _version.py
 │   ├── RasCmdr.py
 │   ├── RasExamples.py
 │   ├── RasGeo.py
+│   ├── RasHdf.py
 │   ├── RasPlan.py
 │   ├── RasPrj.py
 │   ├── RasUnsteady.py
@@ -155,7 +162,12 @@ ras_commander
 │   ├── 10_arguments_for_compute.py
 │   ├── 11_Using_RasExamples.ipynb
 │   ├── 12_plan_set_execution.py
-│   └── 13_multiple_project_operations.py
+│   ├── 13_multiple_project_operations.py
+│   ├── 14_Core_Sensitivity.ipynb
+│   ├── 15_plan_key_operations.py
+│   ├── 16_scanning_ras_project_info.py
+│   ├── 17_parallel_execution_ble.py
+│   └── HEC_RAS_2D_HDF_Analysis.ipynb
 ├── tests
 │   └── ... (test files)
 ├── .gitignore
@@ -190,7 +202,6 @@ projects = ras_examples.list_projects("Steady Flow")
 extracted_paths = ras_examples.extract_project(["Bald Eagle Creek", "Muncie"])
 ```
 
-
 ## RasPrj
 
 The `RasPrj` class is central to managing HEC-RAS projects within the ras-commander library. It handles project initialization, data loading, and provides access to project components.
@@ -218,6 +229,28 @@ custom_project = RasPrj()
 init_ras_project("/path/to/another_project", "6.5", ras_instance=custom_project)
 ```
 
+## RasHdf
+
+The `RasHdf` class provides utilities for working with HDF files in HEC-RAS projects, enabling easy access to simulation results and model data.
+
+Example usage:
+
+```python
+from ras_commander import RasHdf, init_ras_project, RasPrj
+
+# Initialize project with a custom ras object
+custom_ras = RasPrj()
+init_ras_project("/path/to/project", "6.5", ras_instance=custom_ras)
+
+# Get runtime data for a specific plan
+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.
+
+
 ## Documentation
 
 For detailed usage instructions and API documentation, please refer to the [Comprehensive Library Guide](Comprehensive_Library_Guide.md).
@@ -255,7 +288,30 @@ ras-commander is released under the MIT License. See the license file for detail
 
 ## Acknowledgments
 
-RAS Commander is based on the HEC-Commander project's "Command Line is All You Need" approach, leveraging the HEC-RAS command-line interface for automation. The initial development of this library was presented in the HEC-Commander Tools repository.  In a 2024 Australian Water School webinar, Bill demonstrated the derivation of basic HEC-RAS automation functions from plain language instructions. Leveraging the previously developed code and AI tools, the library was created. The primary tools used for this initial development were Anthropic's Claude, GPT-4o, Google's Gemini Experimental models, and the Cursor AI Coding IDE.
+RAS Commander is based on the HEC-Commander project's "Command Line is All You Need" approach, leveraging the HEC-RAS command-line interface for automation. The initial development of this library was presented in the HEC-Commander Tools repository. In a 2024 Australian Water School webinar, Bill demonstrated the derivation of basic HEC-RAS automation functions from plain language instructions. Leveraging the previously developed code and AI tools, the library was created. The primary tools used for this initial development were Anthropic's Claude, GPT-4, Google's Gemini Experimental models, and the Cursor AI Coding IDE.
+
+Additionally, we would like to acknowledge the following notable contributions and attributions for open source projects which significantly influenced the development of RAS Commander:
+
+1. Contributions: Sean Micek's [`funkshuns`](https://github.com/openSourcerer9000/funkshuns), [`TXTure`](https://github.com/openSourcerer9000/TXTure), and [`RASmatazz`](https://github.com/openSourcerer9000/RASmatazz) libraries provided inspiration, code examples and utility functions which were adapted with AI for use in RAS Commander. Sean has also contributed heavily to 
+
+- Development of additional HDF functions for detailed analysis and mapping of HEC-RAS results within the RasHdf class.
+- Development of the prototype `RasCmdr` class for executing HEC-RAS simulations.
+- Optimization examples and methods from (INSERT REFERENCE) for use in the Ras-Commander library examples
+
+2. Attribution: The [`pyHMT2D`](https://github.com/psu-efd/pyHMT2D/) project by Xiaofeng Liu, which provided insights into HDF file handling methods for HEC-RAS outputs.  Many of the functions in the [Ras_2D_Data.py](https://github.com/psu-efd/pyHMT2D/blob/main/pyHMT2D/Hydraulic_Models_Data/RAS_2D/RAS_2D_Data.py) file were adapted with AI for use in RAS Commander. 
+
+   Xiaofeng Liu, Ph.D., P.E.
+   Associate Professor
+   Department of Civil and Environmental Engineering
+   Institute of Computational and Data Sciences
+   Penn State University
+
+These acknowledgments recognize the contributions and inspirations that have helped shape RAS Commander, ensuring proper attribution for the ideas and code that have influenced its development.
+
+3. Chris Goodell, "Breaking the HEC-RAS Code" - Studied and used as a reference for understanding the inner workings of HEC-RAS, providing valuable insights into the software's functionality and structure.
+
+4. [HEC-Commander Tools](https://github.com/billk-FM/HEC-Commander) - Inspiration and initial code base for the development of RAS Commander.
+
 
 ## Contact
 

ras_commander-0.35.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+ras_commander/RasCmdr.py,sha256=fX_rh_IcBuJYEbGXfUc7Fge6cdJAAGKN_V5sGZgIJT4,24447
+ras_commander/RasExamples.py,sha256=VgjBcB56u5gzzzYzz0YXj5rKWk3u7oRoja97_3ArJHc,24127
+ras_commander/RasGeo.py,sha256=6DO5utVBjkIhqJ_WYQSeU4i74Bv_pZO3pmWdVf-jj3U,5137
+ras_commander/RasHdf.py,sha256=z5PZDZ44jS6dYNc1AdDyVqt2YqaMGulR72yBLQYoIeI,83927
+ras_commander/RasPlan.py,sha256=Aa3qhPA8EvEEfSSibeQq2UYawU5kMRCJOgonjBwn8uU,53718
+ras_commander/RasPrj.py,sha256=246bvWbjRCEt-4L1sMovCyNmPWQ6t2uGHkecs9Nro4E,30594
+ras_commander/RasUnsteady.py,sha256=jgV3gqGFsIMV0c9eFaXjVM5pqAb82Du_7ObiIPnemJs,4077
+ras_commander/RasUtils.py,sha256=ESsjQNjPsojZ8SINnMbMZDDWeyBqF6owaPV8brtS3S8,24435
+ras_commander/__init__.py,sha256=7H3JDR5VmTo6P0fJFJe9mTozMWp-owrrHjy7lADVA6Q,1167
+ras_commander/_version.py,sha256=BReLomJ164W3bJhfQJi0gbNKc3DXCzwusmCheUzClB8,478
+ras_commander-0.35.0.dist-info/LICENSE,sha256=_pbd6qHnlsz1iQ-ozDW_49r86BZT6CRwO2iBtw0iN6M,457
+ras_commander-0.35.0.dist-info/METADATA,sha256=k4I3IpZXFOHaMK0Y9CUPuaZ8IlGjBLF5ot4dElRytOQ,15325
+ras_commander-0.35.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+ras_commander-0.35.0.dist-info/top_level.txt,sha256=i76S7eKLFC8doKcXDl3aiOr9RwT06G8adI6YuKbQDaA,14
+ras_commander-0.35.0.dist-info/RECORD,,

ras_commander-0.34.0.dist-info/RECORD

@@ -1,15 +0,0 @@
-ras_commander/RasCmdr.py,sha256=vaB1_33nJMISwCbayYawaVZKjrXy_Jne8KEnfvKxot8,24285
-ras_commander/RasExamples.py,sha256=7A3dt3DnWSdFsZYn9Jqvr93bWNoFSwJYLMiy21hzvgo,16412
-ras_commander/RasGeo.py,sha256=6DO5utVBjkIhqJ_WYQSeU4i74Bv_pZO3pmWdVf-jj3U,5137
-ras_commander/RasHdf.py,sha256=rxe9tlQdeh_wOIUa1lplxbj8JM8HCWZigEHSkySNri4,11222
-ras_commander/RasPlan.py,sha256=5M1ra2oOxGUa2YTRhuKInKq64sXSuVc8bZjvd9N3rOo,53314
-ras_commander/RasPrj.py,sha256=Clso7BccVDd51zCrN3eoAzJ8EXfK6Aai88_spGymOuM,30330
-ras_commander/RasUnsteady.py,sha256=jgV3gqGFsIMV0c9eFaXjVM5pqAb82Du_7ObiIPnemJs,4077
-ras_commander/RasUtils.py,sha256=ESsjQNjPsojZ8SINnMbMZDDWeyBqF6owaPV8brtS3S8,24435
-ras_commander/__init__.py,sha256=7H3JDR5VmTo6P0fJFJe9mTozMWp-owrrHjy7lADVA6Q,1167
-ras_commander/_version.py,sha256=BReLomJ164W3bJhfQJi0gbNKc3DXCzwusmCheUzClB8,478
-ras_commander-0.34.0.dist-info/LICENSE,sha256=_pbd6qHnlsz1iQ-ozDW_49r86BZT6CRwO2iBtw0iN6M,457
-ras_commander-0.34.0.dist-info/METADATA,sha256=qAoJZW8ITX0vGKiqdanV3UUOGph_MeH_SbDOMSFoeaI,11826
-ras_commander-0.34.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-ras_commander-0.34.0.dist-info/top_level.txt,sha256=i76S7eKLFC8doKcXDl3aiOr9RwT06G8adI6YuKbQDaA,14
-ras_commander-0.34.0.dist-info/RECORD,,