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

ras_commander/logging_config.py

@@ -0,0 +1,80 @@
+# logging_config.py
+
+import logging
+import logging.handlers
+from pathlib import Path
+import functools
+
+# Define log levels
+DEBUG = logging.DEBUG
+INFO = logging.INFO
+WARNING = logging.WARNING
+ERROR = logging.ERROR
+CRITICAL = logging.CRITICAL
+
+
+_logging_setup_done = False
+
+def setup_logging(log_file=None, log_level=logging.INFO):
+    """Set up logging configuration for the ras-commander library."""
+    global _logging_setup_done
+    if _logging_setup_done:
+        return
+    
+    # Define log format
+    log_format = logging.Formatter(
+        '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+    )
+
+    # Configure console handler
+    console_handler = logging.StreamHandler()
+    console_handler.setFormatter(log_format)
+
+    # Set up root logger
+    root_logger = logging.getLogger()
+    root_logger.setLevel(log_level)
+    root_logger.addHandler(console_handler)
+
+    # Configure file handler if log_file is provided
+    if log_file:
+        log_dir = Path('logs')
+        log_dir.mkdir(exist_ok=True)
+        log_file_path = log_dir / log_file
+
+        file_handler = logging.handlers.RotatingFileHandler(
+            log_file_path, maxBytes=10*1024*1024, backupCount=5
+        )
+        file_handler.setFormatter(log_format)
+        root_logger.addHandler(file_handler)
+    
+    _logging_setup_done = True
+
+def get_logger(name):
+    """Get a logger for a specific module."""
+    return logging.getLogger(name)
+
+def log_call(logger=None):
+    """Decorator to log function calls."""
+    def get_logger():
+        # Check if logger is None or doesn't have a debug method
+        if logger is None or not hasattr(logger, 'debug'):
+            return logging.getLogger(__name__)
+        return logger
+
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            log = get_logger()
+            log.debug(f"Calling {func.__name__}")
+            result = func(*args, **kwargs)
+            log.debug(f"Finished {func.__name__}")
+            return result
+        return wrapper
+    
+    # Check if we're being called as @log_call or @log_call()
+    if callable(logger):
+        return decorator(logger)
+    return decorator
+
+# Set up logging when this module is imported
+setup_logging()

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

@@ -1,23 +1,25 @@
 Metadata-Version: 2.1
 Name: ras-commander
-Version: 0.34.0
+Version: 0.36.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
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pandas>=1.0.0
-Requires-Dist: numpy>=1.18.0
+Requires-Dist: pandas>=2.0
+Requires-Dist: numpy>=2.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"
@@ -31,14 +33,21 @@ Requires-Dist: twine>=3.3.0; extra == "dev"
 RAS Commander is a Python library for automating HEC-RAS operations, providing a set of tools to interact with HEC-RAS project files, execute simulations, and manage project data. This library is an evolution of the RASCommander 1.0 Python Notebook Application previously released under the [HEC-Commander tools repository](https://github.com/billk-FM/HEC-Commander).
 
 ## Contributors:
-William Katzenmeyer, P.E., C.F.M. - billk@fenstermaker.com  
+William Katzenmeyer, P.E., C.F.M. 
 
-Sean Micek, P.E., C.F.M. - smicek@fenstermaker.com  
+Sean Micek, P.E., C.F.M. 
 
-Aaron Nichols, P.E., C.F.M. - anichols@fenstermaker.com  
+Aaron Nichols, P.E., C.F.M. 
 
 (Additional Contributors Here)  
 
+## Don't Ask Me, Ask ChatGPT!
+
+Before you read any further, you can [chat directly with ChatGPT on this topic.](https://chatgpt.com/g/g-TZRPR3oAO-ras-commander-library-assistant)  Ask it anything, and it will use its tools to answer your questions and help you learn.  You can even upload your own plan, unsteady and HDF files to inspect and help determine how to automate your workflows or visualize your results. 
+
+There are also [AI Assistant Knowledge Bases](https://github.com/billk-FM/ras-commander/tree/main/ai_tools/assistant_knowledge_bases) with various versions available to directly use with large context LLM models such as Anthropic's Claude, Google Gemini and OpenAI's GPT4o and o1 models.  
+
+FUTURE:  TEMPLATES are available to use with AI Assistant Notebooks to build your own automation tools.  When used with large context models, these templates allow you to ask GPT to build a workflow from scratch to automate your projects. 
 
 ## Background
 The ras-commander library emerged from the initial test-bed of AI-driven coding represented by the HEC-Commander tools Python notebooks. These notebooks served as a proof of concept, demonstrating the value proposition of automating HEC-RAS operations. The transition from notebooks to a structured library aims to provide a more robust, maintainable, and extensible solution for water resources engineers.
@@ -116,18 +125,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 +147,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 +169,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 +209,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 +236,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 +295,27 @@ 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.36.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+ras_commander/RasCmdr.py,sha256=_opzPdFuja2wXmFu2iayP6igJqGeILAavPC1XsCC6ks,25010
+ras_commander/RasExamples.py,sha256=g2HIbppxIVeCKriy9Th1RDtrCPzFkdoP-BWEzHPsedY,25112
+ras_commander/RasGeo.py,sha256=cqKpN-1r_uXw24acqA8ubGGw2-Od51p-I_X0kGSkWBE,5395
+ras_commander/RasGpt.py,sha256=-524sU_PBPxCmjDKJbDXg6Q3k1-Uhk2tYj6HeW8QFJ8,4201
+ras_commander/RasHdf.py,sha256=_aJ2PAqFPAnTWN2btmASjWT8dHAFZveAorAu6QXLwgA,77162
+ras_commander/RasPlan.py,sha256=p9IVQ5vKzv01jcrY0-Lbx8N7YwkPf4WKovBNx_FgXpE,48835
+ras_commander/RasPrj.py,sha256=qDJJiWnAaf-Uzc31DVI5aTKjOulIEoVeH05-kjb4tZQ,34444
+ras_commander/RasUnsteady.py,sha256=37GKaYNJZ39y-khhy01LbHwZnf7HT0V2XKQ-UUaJHlY,4639
+ras_commander/RasUtils.py,sha256=P9SopqMd6awZyj0U2xNxc-pl1-HEktmyY1lz3LiduPs,25079
+ras_commander/__init__.py,sha256=h4xld8gpvjTTpOOJcPKXwsRMUVGtg8tRqf64AHwZB3k,1051
+ras_commander/_version.py,sha256=BReLomJ164W3bJhfQJi0gbNKc3DXCzwusmCheUzClB8,478
+ras_commander/logging_config.py,sha256=5bYd_5KMlf81bXsiu2mABBlw0USMhcu5uRv8DIYJSFE,2317
+ras_commander-0.36.0.dist-info/LICENSE,sha256=_pbd6qHnlsz1iQ-ozDW_49r86BZT6CRwO2iBtw0iN6M,457
+ras_commander-0.36.0.dist-info/METADATA,sha256=izerc1IGczuZ6ESEZV2fU5HtEXJA7w5jBMY_u9qFEAE,16187
+ras_commander-0.36.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+ras_commander-0.36.0.dist-info/top_level.txt,sha256=i76S7eKLFC8doKcXDl3aiOr9RwT06G8adI6YuKbQDaA,14
+ras_commander-0.36.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,,