rashdf 0.6.0__tar.gz → 0.7.0__tar.gz

{rashdf-0.6.0 → rashdf-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rashdf
-Version: 0.6.0
+Version: 0.7.0
 Summary: Read data from HEC-RAS HDF files.
 Project-URL: repository, https://github.com/fema-ffrd/rashdf
 Classifier: Development Status :: 4 - Beta
@@ -22,12 +22,12 @@ Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: fiona; extra == "dev"
 Requires-Dist: kerchunk; extra == "dev"
 Requires-Dist: zarr; extra == "dev"
 Requires-Dist: dask; extra == "dev"
 Requires-Dist: fsspec; extra == "dev"
 Requires-Dist: s3fs; extra == "dev"
+Requires-Dist: fiona==1.9.6; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"
@@ -145,8 +145,12 @@ $ python -m venv venv-rashdf
 
 Activate the virtual environment:
 ```
-$ source ./venv/bin/activate
+# For macOS/Linux
+$ source ./venv-rashdf/bin/activate
 (venv-rashdf) $
+
+# For Windows
+> ./venv-rashdf/Scripts/activate
 ```
 
 Install dev dependencies:

{rashdf-0.6.0 → rashdf-0.7.0}/README.md

@@ -110,8 +110,12 @@ $ python -m venv venv-rashdf
 
 Activate the virtual environment:
 ```
-$ source ./venv/bin/activate
+# For macOS/Linux
+$ source ./venv-rashdf/bin/activate
 (venv-rashdf) $
+
+# For Windows
+> ./venv-rashdf/Scripts/activate
 ```
 
 Install dev dependencies:

{rashdf-0.6.0 → rashdf-0.7.0}/pyproject.toml

@@ -12,11 +12,11 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-version = "0.6.0"
+version = "0.7.0"
 dependencies = ["h5py", "geopandas>=1.0,<2.0", "pyarrow", "xarray"]
 
 [project.optional-dependencies]
-dev = ["pre-commit", "ruff", "pytest", "pytest-cov", "fiona", "kerchunk", "zarr", "dask", "fsspec", "s3fs"]
+dev = ["pre-commit", "ruff", "pytest", "pytest-cov", "kerchunk", "zarr", "dask", "fsspec", "s3fs", "fiona==1.9.6"]
 docs = ["sphinx", "numpydoc", "sphinx_rtd_theme"]
 
 [project.urls]

{rashdf-0.6.0 → rashdf-0.7.0}/src/rashdf/plan.py

@@ -6,6 +6,7 @@ from .utils import (
     ras_timesteps_to_datetimes,
     parse_ras_datetime_ms,
     deprecated,
+    convert_ras_hdf_value,
 )
 
 from geopandas import GeoDataFrame
@@ -156,6 +157,7 @@ class RasPlanHdf(RasGeomHdf):
     PLAN_INFO_PATH = "Plan Data/Plan Information"
     PLAN_PARAMS_PATH = "Plan Data/Plan Parameters"
     PRECIP_PATH = "Event Conditions/Meteorology/Precipitation"
+    OBS_DATA_PATH = "Event Conditions/Observed Data"
     RESULTS_UNSTEADY_PATH = "Results/Unsteady"
     RESULTS_UNSTEADY_SUMMARY_PATH = f"{RESULTS_UNSTEADY_PATH}/Summary"
     VOLUME_ACCOUNTING_PATH = f"{RESULTS_UNSTEADY_PATH}/Volume Accounting"
@@ -166,6 +168,8 @@ class RasPlanHdf(RasGeomHdf):
     UNSTEADY_TIME_SERIES_PATH = f"{BASE_OUTPUT_PATH}/Unsteady Time Series"
     REFERENCE_LINES_OUTPUT_PATH = f"{UNSTEADY_TIME_SERIES_PATH}/Reference Lines"
     REFERENCE_POINTS_OUTPUT_PATH = f"{UNSTEADY_TIME_SERIES_PATH}/Reference Points"
+    OBS_FLOW_OUTPUT_PATH = f"{OBS_DATA_PATH}/Flow"
+    OBS_STAGE_OUTPUT_PATH = f"{OBS_DATA_PATH}/Stage"
 
     RESULTS_STEADY_PATH = "Results/Steady"
     BASE_STEADY_PATH = f"{RESULTS_STEADY_PATH}/Output/Output Blocks/Base Output"
@@ -1117,6 +1121,74 @@ class RasPlanHdf(RasGeomHdf):
         """
         return self.reference_timeseries_output(reftype="lines")
 
+    def observed_timeseries_input(self, vartype: str = "Flow") -> dict:
+        """Return observed timeseries input data for reference lines and points from a HEC-RAS HDF plan file.
+
+        Parameters
+        ----------
+        vartype : str, optional
+            The type of observed data to retrieve. Must be either "Flow" or "Stage".
+            (default: "Flow")
+
+        Returns
+        -------
+        xr.Dataset
+            An xarray Dataset with observed timeseries input data for both reference lines and reference points.
+        """
+        if vartype == "Flow":
+            output_path = self.OBS_FLOW_OUTPUT_PATH
+        elif vartype == "Stage":
+            output_path = self.OBS_STAGE_OUTPUT_PATH
+        else:
+            raise ValueError('vartype must be either "Flow" or "Stage".')
+
+        observed_group = self.get(output_path)
+        if observed_group is None:
+            raise RasPlanHdfError(
+                f"Could not find HDF group at path '{output_path}'."
+                f" Does the Plan HDF file contain reference {vartype} output data?"
+            )
+        if "Attributes" in observed_group.keys():
+            attr_path = observed_group["Attributes"]
+            attrs_df = pd.DataFrame(attr_path[:]).map(convert_ras_hdf_value)
+
+        das = {}
+        for idx, site in enumerate(observed_group.keys()):
+            if site != "Attributes":
+                # Site Ex: 'Ref Point: Grapevine_Lake_RP'
+                site_path = observed_group[site]
+                site_name = site.split(":")[1][1:]  # Grapevine_Lake_RP
+                ref_type = site.split(":")[0]  # Ref Point
+                if ref_type == "Ref Line":
+                    ref_type = "refln"
+                else:
+                    ref_type = "refpt"
+                df = pd.DataFrame(site_path[:]).map(convert_ras_hdf_value)
+                # rename Date to time
+                df = df.rename(columns={"Date": "time"})
+                # Ensure the Date index is unique
+                df = df.drop_duplicates(subset="time")
+                # Package into an 1D xarray DataArray
+                values = df["Value"].values
+                times = df["time"].values
+                da = xr.DataArray(
+                    values,
+                    name=vartype,
+                    dims=["time"],
+                    coords={
+                        "time": times,
+                    },
+                    attrs={
+                        "hdf_path": f"{output_path}/{site}",
+                    },
+                )
+                # Expand dimensions to add additional coordinates
+                da = da.expand_dims({f"{ref_type}_id": [idx - 1]})
+                da = da.expand_dims({f"{ref_type}_name": [site_name]})
+                das[site_name] = da
+        das = xr.concat([das[site] for site in das.keys()], dim="time")
+        return das
+
     def reference_points_timeseries_output(self) -> xr.Dataset:
         """Return timeseries output data for reference points from a HEC-RAS HDF plan file.
 

{rashdf-0.6.0 → rashdf-0.7.0}/src/rashdf.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rashdf
-Version: 0.6.0
+Version: 0.7.0
 Summary: Read data from HEC-RAS HDF files.
 Project-URL: repository, https://github.com/fema-ffrd/rashdf
 Classifier: Development Status :: 4 - Beta
@@ -22,12 +22,12 @@ Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: fiona; extra == "dev"
 Requires-Dist: kerchunk; extra == "dev"
 Requires-Dist: zarr; extra == "dev"
 Requires-Dist: dask; extra == "dev"
 Requires-Dist: fsspec; extra == "dev"
 Requires-Dist: s3fs; extra == "dev"
+Requires-Dist: fiona==1.9.6; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"
@@ -145,8 +145,12 @@ $ python -m venv venv-rashdf
 
 Activate the virtual environment:
 ```
-$ source ./venv/bin/activate
+# For macOS/Linux
+$ source ./venv-rashdf/bin/activate
 (venv-rashdf) $
+
+# For Windows
+> ./venv-rashdf/Scripts/activate
 ```
 
 Install dev dependencies:

{rashdf-0.6.0 → rashdf-0.7.0}/src/rashdf.egg-info/requires.txt

@@ -8,12 +8,12 @@ pre-commit
 ruff
 pytest
 pytest-cov
-fiona
 kerchunk
 zarr
 dask
 fsspec
 s3fs
+fiona==1.9.6
 
 [docs]
 sphinx

{rashdf-0.6.0 → rashdf-0.7.0}/tests/test_plan.py

@@ -29,6 +29,7 @@ TEST_ATTRS = {"test_attribute1": "test_str1", "test_attribute2": 500}
 BALD_EAGLE_P18 = TEST_DATA / "ras/BaldEagleDamBrk.p18.hdf"
 BALD_EAGLE_P18_TIMESERIES = TEST_DATA / "ras/BaldEagleDamBrk.p18.timeseries.hdf"
 BALD_EAGLE_P18_REF = TEST_DATA / "ras/BaldEagleDamBrk.reflines-refpts.p18.hdf"
+DENTON = TEST_DATA / "ras/Denton.hdf"
 MUNCIE_G05 = TEST_DATA / "ras/Muncie.g05.hdf"
 COAL_G01 = TEST_DATA / "ras/Coal.g01.hdf"
 BAXTER_P01 = TEST_DATA / "ras_1d/Baxter.p01.hdf"
@@ -617,3 +618,35 @@ def test__mesh_summary_outputs_df(tmp_path):
             TEST_CSV / "BaldEagleDamBrk.summary-cells-selectvars.csv",
             shallow=False,
         )
+
+
+def test_observed_timeseries_input_flow():
+    with RasPlanHdf(DENTON) as phdf:
+        ds = phdf.observed_timeseries_input(vartype="Flow")
+        df = ds.sel(refln_name="Denton-Justin_RL").to_dataframe().dropna().reset_index()
+        valid_df = pd.read_csv(TEST_CSV / "Denton-Justin_RL_Flow.csv")
+        valid_df["time"] = pd.to_datetime(valid_df["time"])
+        assert_frame_equal(df, valid_df)
+
+
+def test_observed_timeseries_input_stage():
+    with RasPlanHdf(DENTON) as phdf:
+        ds = phdf.observed_timeseries_input(vartype="Stage")
+        df = (
+            ds.sel(refpt_name="Grapevine_Lake_RP").to_dataframe().dropna().reset_index()
+        )
+        valid_df = pd.read_csv(TEST_CSV / "Grapevine_Lake_RP_Stage.csv")
+        valid_df["time"] = pd.to_datetime(valid_df["time"])
+        assert_frame_equal(df, valid_df)
+
+
+def test_observed_timeseries_input_value_error():
+    with RasPlanHdf(DENTON) as phdf:
+        with pytest.raises(ValueError):
+            phdf.observed_timeseries_input(vartype="Fake Variable")
+
+
+def test_observed_timeseries_input_rasplanhdf_error():
+    with RasPlanHdf(BALD_EAGLE_P18) as phdf:
+        with pytest.raises(RasPlanHdfError):
+            phdf.observed_timeseries_input(vartype="Flow")