ras-commander 0.77.0__py3-none-any.whl → 0.79.0__py3-none-any.whl

ras_commander/HdfResultsMesh.py

@@ -42,22 +42,6 @@ HdfUtils for common operations. Methods use @log_call decorator for logging and
 
 
 
-REVISIONS MADE:
-
-Use get_ prefix for functions that return data.  
-BUT, we will never set results data, so we should use get_ for results data.
-
-Renamed functions:
-- mesh_summary_output() to get_mesh_summary()
-- mesh_timeseries_output() to get_mesh_timeseries()
-- mesh_faces_timeseries_output() to get_mesh_faces_timeseries()
-- mesh_cells_timeseries_output() to get_mesh_cells_timeseries()
-- mesh_last_iter() to get_mesh_last_iter()
-- mesh_max_ws() to get_mesh_max_ws()
-
-
-
-
 
 
 

ras_commander/RasExamples.py

@@ -69,6 +69,12 @@ class RasExamples:
     examples_dir = base_dir
     projects_dir = examples_dir / 'example_projects'
     csv_file_path = examples_dir / 'example_projects.csv'
+    
+    # Special projects that are not in the main zip file
+    SPECIAL_PROJECTS = {
+        'NewOrleansMetro': 'https://www.hec.usace.army.mil/confluence/rasdocs/hgt/files/latest/299502039/299502111/1/1747692522764/NewOrleansMetroPipesExample.zip',
+        'BeaverLake': 'https://www.hec.usace.army.mil/confluence/rasdocs/hgt/files/latest/299501780/299502090/1/1747692179014/BeaverLake-SWMM-Import-Solution.zip'
+    }
 
     _folder_df = None
     _zip_file_path = None
@@ -148,6 +154,17 @@ class RasExamples:
         extracted_paths = []
 
         for project_name in project_names:
+            # Check if this is a special project
+            if project_name in cls.SPECIAL_PROJECTS:
+                try:
+                    special_path = cls._extract_special_project(project_name)
+                    extracted_paths.append(special_path)
+                    continue
+                except Exception as e:
+                    logger.error(f"Failed to extract special project '{project_name}': {e}")
+                    continue
+            
+            # Regular project extraction logic
             logger.info("----- RasExamples Extracting Project -----")
             logger.info(f"Extracting project '{project_name}'")
             project_path = cls.projects_dir
@@ -319,6 +336,9 @@ class RasExamples:
     def list_projects(cls, category=None):
         """
         List all projects or projects in a specific category.
+        
+        Note: Special projects (NewOrleansMetro, BeaverLake) are also available but not listed
+        in categories as they are downloaded separately.
         """
         if cls._folder_df is None:
             logger.warning("No projects available. Make sure the zip file is properly loaded.")
@@ -328,7 +348,10 @@ class RasExamples:
             logger.info(f"Projects in category '{category}': {', '.join(projects)}")
         else:
             projects = cls._folder_df['Project'].unique()
-            logger.info(f"All available projects: {', '.join(projects)}")
+            # Add special projects to the list
+            all_projects = list(projects) + list(cls.SPECIAL_PROJECTS.keys())
+            logger.info(f"All available projects: {', '.join(all_projects)}")
+            return all_projects
         return projects.tolist()
 
     @classmethod
@@ -421,4 +444,100 @@ class RasExamples:
             raise ValueError(f"Invalid size string: {size_str}")
         
         number, unit = float(re.findall(r'[\d\.]+', size_str)[0]), re.findall(r'[BKMGT]B?', size_str)[0]
-        return int(number * units[unit])
+        return int(number * units[unit])
+
+    @classmethod
+    def _extract_special_project(cls, project_name: str) -> Path:
+        """
+        Download and extract special projects that are not in the main zip file.
+        
+        Args:
+            project_name: Name of the special project ('NewOrleansMetro' or 'BeaverLake')
+            
+        Returns:
+            Path: Path to the extracted project directory
+            
+        Raises:
+            ValueError: If the project is not a recognized special project
+        """
+        if project_name not in cls.SPECIAL_PROJECTS:
+            raise ValueError(f"'{project_name}' is not a recognized special project")
+        
+        logger.info(f"----- RasExamples Extracting Special Project -----")
+        logger.info(f"Extracting special project '{project_name}'")
+        
+        # Create the project directory
+        project_path = cls.projects_dir / project_name
+        
+        # Check if already exists
+        if project_path.exists():
+            logger.info(f"Special project '{project_name}' already exists. Deleting existing folder...")
+            try:
+                shutil.rmtree(project_path)
+                logger.info(f"Existing folder for project '{project_name}' has been deleted.")
+            except Exception as e:
+                logger.error(f"Failed to delete existing project folder '{project_name}': {e}")
+                raise
+        
+        # Create the project directory
+        project_path.mkdir(parents=True, exist_ok=True)
+        
+        # Download the zip file
+        url = cls.SPECIAL_PROJECTS[project_name]
+        zip_file_path = cls.projects_dir / f"{project_name}_temp.zip"
+        
+        logger.info(f"Downloading special project from: {url}")
+        logger.info("This may take a few moments...")
+        
+        try:
+            response = requests.get(url, stream=True, timeout=300)
+            response.raise_for_status()
+            
+            # Get total file size if available
+            total_size = int(response.headers.get('content-length', 0))
+            
+            # Download with progress bar
+            with open(zip_file_path, 'wb') as file:
+                if total_size > 0:
+                    with tqdm(
+                        desc=f"Downloading {project_name}",
+                        total=total_size,
+                        unit='iB',
+                        unit_scale=True,
+                        unit_divisor=1024,
+                    ) as progress_bar:
+                        for chunk in response.iter_content(chunk_size=8192):
+                            size = file.write(chunk)
+                            progress_bar.update(size)
+                else:
+                    # No content length, download without progress bar
+                    for chunk in response.iter_content(chunk_size=8192):
+                        file.write(chunk)
+            
+            logger.info(f"Downloaded special project zip file to {zip_file_path}")
+            
+        except requests.exceptions.RequestException as e:
+            logger.error(f"Failed to download special project '{project_name}': {e}")
+            if zip_file_path.exists():
+                zip_file_path.unlink()
+            raise
+        
+        # Extract the zip file directly to the project directory
+        try:
+            with zipfile.ZipFile(zip_file_path, 'r') as zip_ref:
+                # Extract directly to the project directory (no internal folder structure)
+                zip_ref.extractall(project_path)
+            logger.info(f"Successfully extracted special project '{project_name}' to {project_path}")
+            
+        except Exception as e:
+            logger.error(f"Failed to extract special project '{project_name}': {e}")
+            if project_path.exists():
+                shutil.rmtree(project_path)
+            raise
+        finally:
+            # Clean up the temporary zip file
+            if zip_file_path.exists():
+                zip_file_path.unlink()
+                logger.debug(f"Removed temporary zip file: {zip_file_path}")
+        
+        return project_path

ras_commander/RasGeo.py

@@ -206,10 +206,10 @@ class RasGeo:
         
         # Create DataFrame
         if base_table_rows:
-            df = pd.DataFrame(base_table_rows, columns=['Table Number', 'Land Cover Name', 'Base Manning\'s n Value'])
+            df = pd.DataFrame(base_table_rows, columns=['Table Number', 'Land Cover Name', 'Base Mannings n Value'])
             return df
         else:
-            return pd.DataFrame(columns=['Table Number', 'Land Cover Name', 'Base Manning\'s n Value'])
+            return pd.DataFrame(columns=['Table Number', 'Land Cover Name', 'Base Mannings n Value'])
 
 
     @staticmethod