ras-commander 0.57.0__py3-none-any.whl → 0.58.0__py3-none-any.whl

ras_commander/RasExamples.py

@@ -122,8 +122,16 @@ class RasExamples:
         self._save_to_csv()
 
     @classmethod
-    def extract_project(cls, project_names: Union[str, List[str]]):
-        """Extract one or more specific HEC-RAS projects from the zip file."""
+    def extract_project(cls, project_names: Union[str, List[str]]) -> Union[Path, List[Path]]:
+        """Extract one or more specific HEC-RAS projects from the zip file.
+        
+        Args:
+            project_names: Single project name as string or list of project names
+            
+        Returns:
+            Path: Single Path object if one project extracted
+            List[Path]: List of Path objects if multiple projects extracted
+        """
         logger.debug(f"Extracting projects: {project_names}")
         
         # Initialize if needed
@@ -178,7 +186,8 @@ class RasExamples:
             except Exception as e:
                 logger.error(f"An error occurred while extracting project '{project_name}': {str(e)}")
 
-        return extracted_paths
+        # Return single path if only one project was extracted, otherwise return list
+        return extracted_paths[0] if len(project_names) == 1 else extracted_paths
 
     @classmethod
     def _find_zip_file(cls):

{ras_commander-0.57.0.dist-info → ras_commander-0.58.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ras-commander
-Version: 0.57.0
+Version: 0.58.0
 Summary: A Python library for automating HEC-RAS 6.x operations
 Home-page: https://github.com/gpt-cmdr/ras-commander
 Author: William M. Katzenmeyer, P.E., C.F.M.
@@ -34,16 +34,10 @@ Dynamic: summary
 
 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 was initially conceptualized in the Australian Water School course "AI Tools for Modelling Innovation", and subsequently expanded to cover the basic functionality of the HECRASController COM32 interface using open-source python libraries.  This library uses a Test Driven Development strategy, leveraging the publicly-available HEC-RAS Example projects to create repeatable demonstration examples.  The "Commmander" moniker is inspired by the "Command Line is All You Need" approach to HEC-RAS automation that was first implemented in the HEC-Commander Tools repository. 
 
-## Contributors:
-William Katzenmeyer, P.E., C.F.M. 
+## Repository Author:
+(William Katzenmeyer, P.E., C.F.M.)[https://engineeringwithllms.info]
 
-Sean Micek, P.E., C.F.M. 
-
-Aaron Nichols, P.E., C.F.M. 
-
-(Additional Contributors Here)  
-
-## Don't Ask Me, Ask ChatGPT! 
+## Don't Ask Me, Ask GPT! 
 
 This repository has several methods of interaction with Large Language Models and LLM-Assisted Coding built right in: 
 
@@ -160,8 +154,6 @@ 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, handling initialization and data loading
@@ -267,8 +259,6 @@ Example usage:
 from ras_commander import RasExamples
 
 ```
-ras_examples = RasExamples()
-ras_examples.get_example_projects()  # Downloads example projects if not already present
 categories = ras_examples.list_categories()
 projects = ras_examples.list_projects("Steady Flow")
 extracted_paths = ras_examples.extract_project(["Bald Eagle Creek", "Muncie"])

{ras_commander-0.57.0.dist-info → ras_commander-0.58.0.dist-info}/RECORD

@@ -17,7 +17,7 @@ ras_commander/HdfUtils.py,sha256=VkIKAXBrLwTlk2VtXSO-W3RU-NHpfHbE1QcZUZgl-t8,152
 ras_commander/HdfXsec.py,sha256=flREnFFrIZu4SSKGRQeX9w3SS49q0UWPJnq4zO7DbUM,27342
 ras_commander/LoggingConfig.py,sha256=gWe5K5XTmMQpSczsTysAqpC9my24i_IyM8dvD85fxYg,2704
 ras_commander/RasCmdr.py,sha256=2i9gR5koFfBLwvhYAbNgQFNKKUKqxD1Hf6T9SN9sx-s,26558
-ras_commander/RasExamples.py,sha256=O4h5WwtewoFZjHqQ4i1hhbUUDSCW6TU4MloXqhQTt8U,17090
+ras_commander/RasExamples.py,sha256=6IZ96LcAsk5LYFehdD0zDW5wyZWxQa6OQu2N9upxWXA,17536
 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
@@ -27,8 +27,8 @@ ras_commander/RasToGo.py,sha256=TKujfaV1xQhFaOddF4g2ogGy6ky-CLlfelSMPD2J3Nk,1223
 ras_commander/RasUnsteady.py,sha256=KfCXAag-_bPwwS3JbPZH-s4hbaoHACO0mlRnGrzbFgA,32092
 ras_commander/RasUtils.py,sha256=P2-aBL61kdRINsjnBpstZVD6VVc7hI_D3RUXqr6ldmc,34863
 ras_commander/__init__.py,sha256=mceEWRQJkDBi1o3zVg7DpG2qMrMnKHwwuK3GwyxoVr4,2132
-ras_commander-0.57.0.dist-info/LICENSE,sha256=_pbd6qHnlsz1iQ-ozDW_49r86BZT6CRwO2iBtw0iN6M,457
-ras_commander-0.57.0.dist-info/METADATA,sha256=H1Px65L0_yV2AKMfnDgZ_ukH4GicbbJRaSX4g8Xxzd4,22494
-ras_commander-0.57.0.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-ras_commander-0.57.0.dist-info/top_level.txt,sha256=i76S7eKLFC8doKcXDl3aiOr9RwT06G8adI6YuKbQDaA,14
-ras_commander-0.57.0.dist-info/RECORD,,
+ras_commander-0.58.0.dist-info/LICENSE,sha256=_pbd6qHnlsz1iQ-ozDW_49r86BZT6CRwO2iBtw0iN6M,457
+ras_commander-0.58.0.dist-info/METADATA,sha256=aKq0yFZkuylnSHsK_BRqyie9X30WA9rThWeZQN7X2Ek,22149
+ras_commander-0.58.0.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+ras_commander-0.58.0.dist-info/top_level.txt,sha256=i76S7eKLFC8doKcXDl3aiOr9RwT06G8adI6YuKbQDaA,14
+ras_commander-0.58.0.dist-info/RECORD,,