Merge pull request #56 from fema-ffrd/feature/reference-lines-points

Reference Lines, Reference Points + Summary Output, Timeseries Output
fema-ffrd · Jul 13, 2024 · ac4b788 · ac4b788
2 parents a5a7e2e + 33845d8
commit ac4b788
Show file tree

Hide file tree

Showing 16 changed files with 643 additions and 117 deletions.
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -26,7 +26,6 @@ jobs:
         os: ["ubuntu-latest"]
 
     runs-on: ${{ matrix.os }}
-    environment: ci-env
 
     steps:
     - uses: actions/checkout@v4

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -12,7 +12,6 @@ jobs:
   release:
     name: release
     runs-on: ubuntu-latest
-    environment: release-env
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python

diff --git a/README.md b/README.md
@@ -47,8 +47,8 @@ Also, methods to extract certain HDF group attributes as dictionaries:
 ```python
 >>> from rashdf import RasPlanHdf
 >>> with RasPlanHdf("path/to/rasmodel/Muncie.p04.hdf") as plan_hdf:
->>> results_unsteady_summary = plan_hdf.get_results_unsteady_summary()
->>> results_unsteady_summary
+>>> results_unsteady_summary_attrs = plan_hdf.get_results_unsteady_summary_attrs()
+>>> results_unsteady_summary_attrs
 {'Computation Time DSS': datetime.timedelta(0),
 'Computation Time Total': datetime.timedelta(seconds=23),
 'Maximum WSEL Error': 0.0099277812987566,

diff --git a/docs/source/RasGeomHdf.rst b/docs/source/RasGeomHdf.rst
@@ -12,6 +12,10 @@ RasGeomHdf
              bc_lines,
              breaklines,
              refinement_regions,
+             reference_lines,
+             reference_lines_names,
+             reference_points,
+             reference_points_names,
              structures,
              get_geom_attrs,
              get_geom_structures_attrs,

diff --git a/docs/source/RasPlanHdf.rst b/docs/source/RasPlanHdf.rst
@@ -13,6 +13,10 @@ RasPlanHdf
              mesh_max_ws_err,
              mesh_max_iter,
              mesh_last_iter,
+             reference_lines,
+             reference_lines_names,
+             reference_points,
+             reference_points_names,
              get_plan_info_attrs,
              get_plan_param_attrs,
              get_meteorology_precip_attrs,

diff --git a/pyproject.toml b/pyproject.toml
@@ -12,7 +12,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-version = "0.4.0"
+version = "0.5.0"
 dependencies = ["h5py", "geopandas>=0.14,<0.15", "pyarrow", "xarray"]
 
 [project.optional-dependencies]

diff --git a/src/cli.py b/src/cli.py
@@ -23,6 +23,8 @@
     "refinement_regions",
     "bc_lines",
     "breaklines",
+    "reference_lines",
+    "reference_points",
     "structures",
 ]