ras-commander 0.35.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.35.0.dist-info → ras_commander-0.36.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ras-commander
-Version: 0.35.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
@@ -12,8 +12,8 @@ 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: scipy>=1.5.0
@@ -33,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.
@@ -300,11 +307,8 @@ Additionally, we would like to acknowledge the following notable contributions a
 
 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
+   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.
 

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.35.0.dist-info/RECORD

@@ -1,15 +0,0 @@
-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,,