ras-commander 0.40.0__py3-none-any.whl → 0.41.0__py3-none-any.whl

ras_commander/RasUtils.py

@@ -24,12 +24,13 @@ Example:
 import os
 from pathlib import Path
 from .RasPrj import ras
-from typing import Union, Optional, Dict
+from typing import Union, Optional, Dict, Callable
 import pandas as pd
 import numpy as np
 import shutil
 from ras_commander import get_logger
 from ras_commander.logging_config import get_logger, log_call
+import re
 
 logger = get_logger(__name__)
 # Module code starts here
@@ -622,6 +623,118 @@ class RasUtils:
         logger.info(f"Calculated error metrics: {metrics}")
         return metrics
 
+    
+    @staticmethod
+    @log_call
+    def update_file(file_path: Path, update_function: Callable, *args) -> None:
+        """
+        Generic method to update a file.
 
+        Parameters:
+        file_path (Path): Path to the file to be updated
+        update_function (Callable): Function to update the file contents
+        *args: Additional arguments to pass to the update_function
 
+        Raises:
+        Exception: If there's an error updating the file
 
+        Example:
+        >>> def update_content(lines, new_value):
+        ...     lines[0] = f"New value: {new_value}\\n"
+        ...     return lines
+        >>> RasUtils.update_file(Path("example.txt"), update_content, "Hello")
+        """
+        try:
+            with open(file_path, 'r') as f:
+                lines = f.readlines()
+            
+            updated_lines = update_function(lines, *args) if args else update_function(lines)
+            
+            with open(file_path, 'w') as f:
+                f.writelines(updated_lines)
+            logger.info(f"Successfully updated file: {file_path}")
+        except Exception as e:
+            logger.exception(f"Failed to update file {file_path}")
+            raise
+
+    @staticmethod
+    @log_call
+    def get_next_number(existing_numbers: list) -> str:
+        """
+        Determine the next available number from a list of existing numbers.
+
+        Parameters:
+        existing_numbers (list): List of existing numbers as strings
+
+        Returns:
+        str: Next available number as a zero-padded string
+
+        Example:
+        >>> RasUtils.get_next_number(["01", "02", "04"])
+        "05"
+        """
+        existing_numbers = sorted(int(num) for num in existing_numbers)
+        next_number = max(existing_numbers, default=0) + 1
+        return f"{next_number:02d}"
+
+    @staticmethod
+    @log_call
+    def clone_file(template_path: Path, new_path: Path, update_function: Optional[Callable] = None, *args) -> None:
+        """
+        Generic method to clone a file and optionally update it.
+
+        Parameters:
+        template_path (Path): Path to the template file
+        new_path (Path): Path where the new file will be created
+        update_function (Optional[Callable]): Function to update the cloned file
+        *args: Additional arguments to pass to the update_function
+
+        Raises:
+        FileNotFoundError: If the template file doesn't exist
+
+        Example:
+        >>> def update_content(lines, new_value):
+        ...     lines[0] = f"New value: {new_value}\\n"
+        ...     return lines
+        >>> RasUtils.clone_file(Path("template.txt"), Path("new.txt"), update_content, "Hello")
+        """
+        if not template_path.exists():
+            logger.error(f"Template file '{template_path}' does not exist.")
+            raise FileNotFoundError(f"Template file '{template_path}' does not exist.")
+
+        shutil.copy(template_path, new_path)
+        logger.info(f"File cloned from {template_path} to {new_path}")
+
+        if update_function:
+            RasUtils.update_file(new_path, update_function, *args)
+    @staticmethod
+    @log_call
+    def update_project_file(prj_file: Path, file_type: str, new_num: str, ras_object=None) -> None:
+        """
+        Update the project file with a new entry.
+
+        Parameters:
+        prj_file (Path): Path to the project file
+        file_type (str): Type of file being added (e.g., 'Plan', 'Geom')
+        new_num (str): Number of the new file entry
+        ras_object (RasPrj, optional): RAS object to use. If None, uses the default ras object.
+
+        Example:
+        >>> RasUtils.update_project_file(Path("project.prj"), "Plan", "02")
+        """
+        ras_obj = ras_object or ras
+        ras_obj.check_initialized()
+        
+        try:
+            with open(prj_file, 'r') as f:
+                lines = f.readlines()
+            
+            new_line = f"{file_type} File={file_type[0].lower()}{new_num}\n"
+            lines.append(new_line)
+            
+            with open(prj_file, 'w') as f:
+                f.writelines(lines)
+            logger.info(f"Project file updated with new {file_type} entry: {new_num}")
+        except Exception as e:
+            logger.exception(f"Failed to update project file {prj_file}")
+            raise

{ras_commander-0.40.0.dist-info → ras_commander-0.41.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ras-commander
-Version: 0.40.0
+Version: 0.41.0
 Summary: A Python library for automating HEC-RAS operations
 Home-page: https://github.com/billk-FM/ras-commander
 Author: William M. Katzenmeyer
@@ -61,10 +61,11 @@ 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 pandas requests pathlib
+pip install h5py numpy pandas requests tqdm scipy
 pip install 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.  
    
 
 ## Requirements

ras_commander-0.41.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+ras_commander/RasCmdr.py,sha256=_opzPdFuja2wXmFu2iayP6igJqGeILAavPC1XsCC6ks,25010
+ras_commander/RasExamples.py,sha256=XKnbqQTc5t43iFkjJLF3lgqZW4YaGh-79sGYDAmtqiU,19245
+ras_commander/RasGeo.py,sha256=GiRtgRg0JsuCDkpYS6SkJoaLksPUskHGDRpJLYVUMz8,5411
+ras_commander/RasGpt.py,sha256=-524sU_PBPxCmjDKJbDXg6Q3k1-Uhk2tYj6HeW8QFJ8,4201
+ras_commander/RasHdf.py,sha256=Und1QcOpuHD2dCZvxPiwNXCoEQs_XG9WFGBlNwMDDrE,32689
+ras_commander/RasPlan.py,sha256=GT8-2X_Or6ufrfpQPv6G3WMLuTNsOO0OCYh1jrbsqZ0,40303
+ras_commander/RasPrj.py,sha256=-iEltmz7B-wXrs4R3iuj6tXX9i-6u_yEl7ZcLmasoWs,33980
+ras_commander/RasUnsteady.py,sha256=37GKaYNJZ39y-khhy01LbHwZnf7HT0V2XKQ-UUaJHlY,4639
+ras_commander/RasUtils.py,sha256=vA3DzvNMeKH3A4cMQLK2a3dihftXBGypYvoi-ckMlSs,29480
+ras_commander/__init__.py,sha256=h4xld8gpvjTTpOOJcPKXwsRMUVGtg8tRqf64AHwZB3k,1051
+ras_commander/logging_config.py,sha256=5bYd_5KMlf81bXsiu2mABBlw0USMhcu5uRv8DIYJSFE,2317
+ras_commander-0.41.0.dist-info/LICENSE,sha256=_pbd6qHnlsz1iQ-ozDW_49r86BZT6CRwO2iBtw0iN6M,457
+ras_commander-0.41.0.dist-info/METADATA,sha256=wYlsP7QFa-lYa5CUKg8Mbi6VFwojfJm_l1GK_TVgCew,15671
+ras_commander-0.41.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+ras_commander-0.41.0.dist-info/top_level.txt,sha256=i76S7eKLFC8doKcXDl3aiOr9RwT06G8adI6YuKbQDaA,14
+ras_commander-0.41.0.dist-info/RECORD,,

ras_commander/_version.py

@@ -1,16 +0,0 @@
-# file generated by setuptools_scm
-# don't change, don't track in version control
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple, Union
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-else:
-    VERSION_TUPLE = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-
-__version__ = version = '0.29.dev1+g22e75d4.d20240919'
-__version_tuple__ = version_tuple = (0, 29, 'dev1', 'g22e75d4.d20240919')

ras_commander-0.40.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-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.40.0.dist-info/LICENSE,sha256=_pbd6qHnlsz1iQ-ozDW_49r86BZT6CRwO2iBtw0iN6M,457
-ras_commander-0.40.0.dist-info/METADATA,sha256=78DRlI1Qcckp4bsA3mxbdxMAU5WnANe_tPc1D8J24BE,15440
-ras_commander-0.40.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-ras_commander-0.40.0.dist-info/top_level.txt,sha256=i76S7eKLFC8doKcXDl3aiOr9RwT06G8adI6YuKbQDaA,14
-ras_commander-0.40.0.dist-info/RECORD,,