rashdf 0.2.1__py3-none-any.whl → 0.2.2__py3-none-any.whl

cli.py

@@ -1,3 +1,5 @@
+"""rashdf CLI."""
+
 from rashdf import RasGeomHdf
 from rashdf.utils import df_datetimes_to_str
 
@@ -60,6 +62,7 @@ def fiona_supported_drivers() -> List[str]:
 
 
 def parse_args(args: str) -> argparse.Namespace:
+    """Parse command-line arguments."""
     parser = argparse.ArgumentParser(description="Extract data from HEC-RAS HDF files.")
     parser.add_argument(
         "--fiona-drivers",
@@ -100,6 +103,7 @@ def parse_args(args: str) -> argparse.Namespace:
 
 
 def export(args: argparse.Namespace) -> Optional[str]:
+    """Act on parsed arguments to extract data from HEC-RAS HDF files."""
     if args.fiona_drivers:
         for driver in fiona_supported_drivers():
             print(driver)
@@ -147,6 +151,7 @@ def export(args: argparse.Namespace) -> Optional[str]:
 
 
 def main():
+    """Entry point for the rashdf CLI."""
     args = parse_args(sys.argv[1:])
     export(args)
 

rashdf/__init__.py

@@ -1,3 +1,5 @@
+"""rashdf package."""
+
 from .base import RasHdf
 from .geom import RasGeomHdf
 from .plan import RasPlanHdf

rashdf/base.py

@@ -1,3 +1,5 @@
+"""Base class for reading HEC-RAS HDF files."""
+
 import h5py
 from .utils import hdf5_attrs_to_dict
 from typing import Dict
@@ -68,7 +70,7 @@ class RasHdf(h5py.File):
         return {}
 
     def get_root_attrs(self):
-        """Returns attributes at root level of HEC-RAS HDF file.
+        """Return attributes at root level of HEC-RAS HDF file.
 
         Returns
         -------

rashdf/geom.py

@@ -1,3 +1,5 @@
+"""HEC-RAS Geometry HDF class."""
+
 from .base import RasHdf
 from .utils import (
     convert_ras_hdf_string,
@@ -16,27 +18,37 @@ from shapely import (
     LineString,
     MultiLineString,
     MultiPolygon,
-    polygonize,
+    polygonize_full,
 )
 
-from typing import List, Optional
+from typing import Dict, List, Optional
 
 
 class RasGeomHdf(RasHdf):
+    """HEC-RAS Geometry HDF class."""
+
     GEOM_PATH = "Geometry"
     GEOM_STRUCTURES_PATH = f"{GEOM_PATH}/Structures"
     FLOW_AREA_2D_PATH = f"{GEOM_PATH}/2D Flow Areas"
 
     def __init__(self, name: str, **kwargs):
+        """Open a HEC-RAS Geometry HDF file.
+
+        Parameters
+        ----------
+        name : str
+            The path to the RAS Geometry HDF file.
+        kwargs : dict
+            Additional keyword arguments to pass to h5py.File
+        """
         super().__init__(name, **kwargs)
 
     def projection(self) -> Optional[CRS]:
-        """Return the projection of the RAS geometry as a
-        pyproj.CRS object.
+        """Return the projection of the RAS geometry as a pyproj.CRS object.
 
         Returns
         -------
-        CRS
+        pyproj.CRS or None
             The projection of the RAS geometry.
         """
         proj_wkt = self.attrs.get("Projection")
@@ -47,12 +59,11 @@ class RasGeomHdf(RasHdf):
         return CRS.from_wkt(proj_wkt)
 
     def mesh_area_names(self) -> List[str]:
-        """Return a list of the 2D mesh area names of
-        the RAS geometry.
+        """Return a list of the 2D mesh area names of the RAS geometry.
 
         Returns
         -------
-        list
+        List[str]
             A list of the 2D mesh area names (str) within the RAS geometry if 2D areas exist.
         """
         if "/Geometry/2D Flow Areas" not in self:
@@ -128,13 +139,19 @@ class RasGeomHdf(RasHdf):
             cell_dict["cell_id"] += cell_ids
             cell_dict["geometry"] += list(
                 np.vectorize(
-                    lambda face_id_list: polygonize(
-                        np.ravel(
-                            mesh_faces[
-                                np.array(face_id_list.strip("[]").split()).astype(int)
-                            ]
+                    lambda face_id_list: (
+                        lambda geom_col: Polygon((geom_col[0] or geom_col[3]).geoms[0])
+                    )(
+                        polygonize_full(
+                            np.ravel(
+                                mesh_faces[
+                                    np.array(face_id_list.strip("[]").split()).astype(
+                                        int
+                                    )
+                                ]
+                            )
                         )
-                    ).geoms[0]
+                    )
                 )(face_id_lists)
             )
         return GeoDataFrame(cell_dict, geometry="geometry", crs=self.projection())
@@ -206,8 +223,8 @@ class RasGeomHdf(RasHdf):
                 face_dict["geometry"].append(LineString(coordinates))
         return GeoDataFrame(face_dict, geometry="geometry", crs=self.projection())
 
-    def get_geom_attrs(self):
-        """Returns base geometry attributes from a HEC-RAS HDF file.
+    def get_geom_attrs(self) -> Dict:
+        """Return base geometry attributes from a HEC-RAS HDF file.
 
         Returns
         -------
@@ -216,8 +233,8 @@ class RasGeomHdf(RasHdf):
         """
         return self.get_attrs(self.GEOM_PATH)
 
-    def get_geom_structures_attrs(self):
-        """Returns geometry structures attributes from a HEC-RAS HDF file.
+    def get_geom_structures_attrs(self) -> Dict:
+        """Return geometry structures attributes from a HEC-RAS HDF file.
 
         Returns
         -------
@@ -226,8 +243,8 @@ class RasGeomHdf(RasHdf):
         """
         return self.get_attrs(self.GEOM_STRUCTURES_PATH)
 
-    def get_geom_2d_flow_area_attrs(self):
-        """Returns geometry 2d flow area attributes from a HEC-RAS HDF file.
+    def get_geom_2d_flow_area_attrs(self) -> Dict:
+        """Return geometry 2d flow area attributes from a HEC-RAS HDF file.
 
         Returns
         -------
@@ -373,6 +390,11 @@ class RasGeomHdf(RasHdf):
     def structures(self, datetime_to_str: bool = False) -> GeoDataFrame:
         """Return the model structures.
 
+        Parameters
+        ----------
+        datetime_to_str : bool, optional
+            If True, convert datetime values to string format (default: False).
+
         Returns
         -------
         GeoDataFrame
@@ -419,50 +441,50 @@ class RasGeomHdf(RasHdf):
             )
         return struct_gdf
 
-    def connections(self) -> GeoDataFrame:
+    def connections(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def ic_points(self) -> GeoDataFrame:
+    def ic_points(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def reference_lines(self) -> GeoDataFrame:
+    def reference_lines(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def reference_points(self) -> GeoDataFrame:
+    def reference_points(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def pump_stations(self) -> GeoDataFrame:
+    def pump_stations(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def mannings_calibration_regions(self) -> GeoDataFrame:
+    def mannings_calibration_regions(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def classification_polygons(self) -> GeoDataFrame:
+    def classification_polygons(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def terrain_modifications(self) -> GeoDataFrame:
+    def terrain_modifications(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def cross_sections(self) -> GeoDataFrame:
+    def cross_sections(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def river_reaches(self) -> GeoDataFrame:
+    def river_reaches(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def flowpaths(self) -> GeoDataFrame:
+    def flowpaths(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def bank_points(self) -> GeoDataFrame:
+    def bank_points(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def bank_lines(self) -> GeoDataFrame:
+    def bank_lines(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def ineffective_areas(self) -> GeoDataFrame:
+    def ineffective_areas(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def ineffective_points(self) -> GeoDataFrame:
+    def ineffective_points(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError
 
-    def blocked_obstructions(self) -> GeoDataFrame:
+    def blocked_obstructions(self) -> GeoDataFrame:  # noqa D102
         raise NotImplementedError

rashdf/plan.py

@@ -1,9 +1,13 @@
+"""HEC-RAS Plan HDF class."""
+
 from .geom import RasGeomHdf
 from typing import Dict
 from geopandas import GeoDataFrame
 
 
 class RasPlanHdf(RasGeomHdf):
+    """HEC-RAS Plan HDF class."""
+
     PLAN_INFO_PATH = "Plan Data/Plan Information"
     PLAN_PARAMS_PATH = "Plan Data/Plan Parameters"
     PRECIP_PATH = "Event Conditions/Meteorology/Precipitation"
@@ -12,67 +16,76 @@ class RasPlanHdf(RasGeomHdf):
     VOLUME_ACCOUNTING_PATH = f"{RESULTS_UNSTEADY_PATH}/Volume Accounting"
 
     def __init__(self, name: str, **kwargs):
+        """Open a HEC-RAS Plan HDF file.
+
+        Parameters
+        ----------
+        name : str
+            The path to the RAS Plan HDF file.
+        kwargs : dict
+            Additional keyword arguments to pass to h5py.File
+        """
         super().__init__(name, **kwargs)
 
     def get_plan_info_attrs(self) -> Dict:
-        """Returns plan information attributes from a HEC-RAS HDF plan file.
+        """Return plan information attributes from a HEC-RAS HDF plan file.
 
         Returns
         -------
         dict
-            Dictionary filled with plan information attributes.
+            Dictionary of plan information attributes.
         """
         return self.get_attrs(self.PLAN_INFO_PATH)
 
     def get_plan_param_attrs(self) -> Dict:
-        """Returns plan parameter attributes from a HEC-RAS HDF plan file.
+        """Return plan parameter attributes from a HEC-RAS HDF plan file.
 
         Returns
         -------
         dict
-            Dictionary filled with plan parameter attributes.
+            Dictionary of plan parameter attributes.
         """
         return self.get_attrs(self.PLAN_PARAMS_PATH)
 
     def get_meteorology_precip_attrs(self) -> Dict:
-        """Returns precipitation attributes from a HEC-RAS HDF plan file.
+        """Return precipitation attributes from a HEC-RAS HDF plan file.
 
         Returns
         -------
         dict
-            Dictionary filled with precipitation attributes.
+            Dictionary of precipitation attributes.
         """
         return self.get_attrs(self.PRECIP_PATH)
 
     def get_results_unsteady_attrs(self) -> Dict:
-        """Returns unsteady attributes from a HEC-RAS HDF plan file.
+        """Return unsteady attributes from a HEC-RAS HDF plan file.
 
         Returns
         -------
         dict
-            Dictionary filled with unsteady attributes.
+            Dictionary of unsteady attributes.
         """
         return self.get_attrs(self.RESULTS_UNSTEADY_PATH)
 
     def get_results_unsteady_summary_attrs(self) -> Dict:
-        """Returns results unsteady summary attributes from a HEC-RAS HDF plan file.
+        """Return results unsteady summary attributes from a HEC-RAS HDF plan file.
 
         Returns
         -------
         dict
-            Dictionary filled with results summary attributes.
+            Dictionary of results summary attributes.
         """
         return self.get_attrs(self.RESULTS_UNSTEADY_SUMMARY_PATH)
 
     def get_results_volume_accounting_attrs(self) -> Dict:
-        """Returns volume accounting attributes from a HEC-RAS HDF plan file.
+        """Return volume accounting attributes from a HEC-RAS HDF plan file.
 
         Returns
         -------
         dict
-            Dictionary filled with volume accounting attributes.
+            Dictionary of volume accounting attributes.
         """
         return self.get_attrs(self.VOLUME_ACCOUNTING_PATH)
 
-    def enroachment_points(self) -> GeoDataFrame:
+    def enroachment_points(self) -> GeoDataFrame:  # noqa: D102
         raise NotImplementedError

rashdf/utils.py

@@ -1,3 +1,5 @@
+"""Utility functions for reading HEC-RAS HDF data."""
+
 import h5py
 import numpy as np
 import pandas as pd
@@ -5,12 +7,13 @@ import pandas as pd
 from datetime import datetime, timedelta
 import re
 from typing import Any, List, Tuple, Union, Optional
+from shapely import LineString, Polygon, polygonize_full
 
 
 def parse_ras_datetime(datetime_str: str) -> datetime:
-    """
-    Parse a datetime string from a RAS file into a datetime object. If the datetime has
-    a time of 2400, then it is converted to midnight of the next day.
+    """Parse a datetime string from a RAS file into a datetime object.
+
+    If the datetime has a time of 2400, then it is converted to midnight of the next day.
 
     Parameters
     ----------
@@ -34,8 +37,9 @@ def parse_ras_datetime(datetime_str: str) -> datetime:
 
 def parse_ras_simulation_window_datetime(datetime_str) -> datetime:
     """
-    Parse a datetime string from a RAS simulation window into a datetime object.If the datetime has a
-    time of 2400, then it is converted to midnight of the next day.
+    Parse a datetime string from a RAS simulation window into a datetime object.
+
+    If the datetime has a time of 2400, then it is converted to midnight of the next day.
 
     Parameters
     ----------
@@ -202,13 +206,13 @@ def hdf5_attrs_to_dict(attrs: dict, prefix: str = None) -> dict:
     """
     Convert a dictionary of attributes from an HDF5 file into a Python dictionary.
 
-    Parameters:
+    Parameters
     ----------
         attrs (dict): The attributes to be converted.
         prefix (str, optional): An optional prefix to prepend to the keys.
 
-    Returns:
-    ----------
+    Returns
+    -------
         dict: A dictionary with the converted attributes.
     """
     results = {}
@@ -229,12 +233,12 @@ def get_first_hdf_group(parent_group: h5py.Group) -> Optional[h5py.Group]:
     This function iterates over the items in the parent group and returns the first item that is an instance of
      h5py.Group. If no such item is found, it returns None.
 
-    Parameters:
+    Parameters
     ----------
         parent_group (h5py.Group): The parent group to search in.
 
-    Returns:
-    ----------
+    Returns
+    -------
         Optional[h5py.Group]: The first HDF5 group in the parent group, or None if no group is found.
     """
     for _, item in parent_group.items():

{rashdf-0.2.1.dist-info → rashdf-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rashdf
-Version: 0.2.1
+Version: 0.2.2
 Summary: Read data from HEC-RAS HDF files.
 Project-URL: repository, https://github.com/fema-ffrd/rashdf
 Classifier: Development Status :: 4 - Beta
@@ -20,16 +20,26 @@ Provides-Extra: dev
 Requires-Dist: pre-commit ; extra == 'dev'
 Requires-Dist: ruff ; extra == 'dev'
 Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: pytest-cov ; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: sphinx ; extra == 'docs'
+Requires-Dist: numpydoc ; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
 
 # rashdf
 [![CI](https://github.com/fema-ffrd/rashdf/actions/workflows/continuous-integration.yml/badge.svg?branch=main)](https://github.com/fema-ffrd/rashdf/actions/workflows/continuous-integration.yml)
 [![Release](https://github.com/fema-ffrd/rashdf/actions/workflows/release.yml/badge.svg)](https://github.com/fema-ffrd/rashdf/actions/workflows/release.yml)
 [![PyPI version](https://badge.fury.io/py/rashdf.svg)](https://badge.fury.io/py/rashdf)
+[![codecov](https://codecov.io/gh/fema-ffrd/rashdf/graph/badge.svg?token=CTIIONEHV1)](https://codecov.io/gh/fema-ffrd/rashdf)
+[![Documentation Status](https://readthedocs.org/projects/rashdf/badge/?version=latest)](https://rashdf.readthedocs.io/en/latest/?badge=latest)
 
 Read data from [HEC-RAS](https://www.hec.usace.army.mil/software/hec-ras/) [HDF](https://github.com/HDFGroup/hdf5) files.
 
 *Pronunciation: `raz·aitch·dee·eff`*
 
+## Documentation
+[rashdf on ReadTheDocs](http://rashdf.readthedocs.io/)
+
 ## Install
 ```bash
 $ pip install rashdf
@@ -120,9 +130,6 @@ Example: write structures GeoJSON to `stdout`:
 $ rashdf structures Potomac.p01.hdf
 ```
 
-## Documentation
-Coming soon.
-
 ## Developer Setup
 Create a virtual environment in the project directory:
 ```

rashdf-0.2.2.dist-info/RECORD

@@ -0,0 +1,12 @@
+cli.py,sha256=QMTNosimfe95bQn2_ovLB98GeaQ0gwMTMA1rboMEknw,5119
+rashdf/__init__.py,sha256=XXFtJDgLPCimqAhfsFz_pTWYECJiRT0i-Kb1uflXmVU,156
+rashdf/base.py,sha256=lHYVDwFTA1qFI34QYZ55QKcp7b8CeZsmDfESdkYISbg,2432
+rashdf/geom.py,sha256=8bdATVPc_HxECA9evnwyL3nXC5YHEY78I3JpUUP4_xM,17597
+rashdf/plan.py,sha256=8xdDkAvk9sTrBlCcXepuNvGRbp0JjlyHdRMFN5PRiHE,2734
+rashdf/utils.py,sha256=yEZCm06KjpL8pebbW4MIDIcX2vHp-IzVXsKJGKznWBc,8703
+rashdf-0.2.2.dist-info/LICENSE,sha256=L_0QaLpQVHPcglVjiaJPnOocwzP8uXevDRjUPr9DL1Y,1065
+rashdf-0.2.2.dist-info/METADATA,sha256=4MuaGRrWegMZ4RVGtuYl6KjWpksteMTTj36gwAvGjCo,5636
+rashdf-0.2.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+rashdf-0.2.2.dist-info/entry_points.txt,sha256=LHHMR1lLy4wRyscMuW1RlYDXemtPgqQhNcILz0DtStY,36
+rashdf-0.2.2.dist-info/top_level.txt,sha256=SrmLb6FFTJtM_t6O1v0M0JePshiQJMHr0yYVkHL7ztk,11
+rashdf-0.2.2.dist-info/RECORD,,

rashdf-0.2.1.dist-info/RECORD

@@ -1,12 +0,0 @@
-cli.py,sha256=q8t-gT0iPfWDmUL0nod9xGFZi1-BF3drZL2I0qoF1Lw,4944
-rashdf/__init__.py,sha256=r_UaNbJve1yWg-2r7qFiZVMdYiq4m5LNoRLJKL4HYYk,133
-rashdf/base.py,sha256=yTihpXoSm-S6kb1BGdru4UPIR3_-mDFrcEaQfXd8ujY,2384
-rashdf/geom.py,sha256=PRdof8Zyq2KeO0zHSDxHmb0gPY5tJwyus7EWMmUEMFA,16612
-rashdf/plan.py,sha256=GU8BlRBN27R-letDhF_fOK1xAaJsL4CSYEyBCiDBaPs,2472
-rashdf/utils.py,sha256=2pXPffggO1O19VbiWCTKK0D8BBdvWFRGUSgpcZypCYg,8603
-rashdf-0.2.1.dist-info/LICENSE,sha256=L_0QaLpQVHPcglVjiaJPnOocwzP8uXevDRjUPr9DL1Y,1065
-rashdf-0.2.1.dist-info/METADATA,sha256=YCWyg7Nok0jtER6gFJxcwEgBnHp9fkq0Ad8si4bxJ9A,5128
-rashdf-0.2.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-rashdf-0.2.1.dist-info/entry_points.txt,sha256=LHHMR1lLy4wRyscMuW1RlYDXemtPgqQhNcILz0DtStY,36
-rashdf-0.2.1.dist-info/top_level.txt,sha256=SrmLb6FFTJtM_t6O1v0M0JePshiQJMHr0yYVkHL7ztk,11
-rashdf-0.2.1.dist-info/RECORD,,