Merge pull request #391 from RTIInternational/390-release-v048

390 release v048

Author: samlamont

README.md

@@ -37,8 +37,8 @@ python -m teehr.utils.install_spark_jars
 ```
 Use Docker
 ```bash
-$ docker build -t teehr:v0.4.7 .
-$ docker run -it --rm --volume $HOME:$HOME -p 8888:8888 teehr:v0.4.7 jupyter lab --ip 0.0.0.0 $HOME
+$ docker build -t teehr:v0.4.8 .
+$ docker run -it --rm --volume $HOME:$HOME -p 8888:8888 teehr:v0.4.8 jupyter lab --ip 0.0.0.0 $HOME
 ```
 
 ## Examples

docs/sphinx/api/index.rst

@@ -19,6 +19,7 @@ The top-level class for interacting with and exploring a TEEHR Evaluation.
 .. autosummary::
    :template: custom-class-template.rst
    :toctree: generated
+   :nosignatures:
 
    Evaluation
 
@@ -29,6 +30,7 @@ Creating and Managing an Evaluation
 Methods for creating, cloning, and configuring an Evaluation.
 
 .. autosummary::
+   :nosignatures:
 
    Evaluation.clone_template
    Evaluation.list_s3_evaluations
@@ -45,6 +47,7 @@ Classes for creating, describing, and querying the Evaluation dataset tables.
 .. autosummary::
    :template: custom-class-template.rst
    :toctree: generated
+   :nosignatures:
 
    BaseTable
    UnitTable
@@ -66,6 +69,7 @@ Methods for fetching NWM and USGS data from external sources.
 
 .. autosummary::
    :toctree: generated
+   :nosignatures:
 
    Fetch.usgs_streamflow
    Fetch.nwm_retrospective_points
@@ -83,6 +87,7 @@ Functions for calculating metrics.
    :toctree: generated
    :template: custom-module-template.rst
    :recursive:
+   :nosignatures:
 
    teehr.metrics.deterministic_funcs
    teehr.metrics.signature_funcs
@@ -98,6 +103,7 @@ Classes for defining and customizing metrics and bootstrap models.
    :toctree: generated
    :template: custom-class-template.rst
    :recursive:
+   :nosignatures:
 
    DeterministicMetrics
    SignatureMetrics
@@ -113,6 +119,7 @@ Classes for defining and customizing user-defined field models.
 .. autosummary::
    :toctree: generated
    :template: custom-class-template.rst
+   :nosignatures:
 
    RowLevelCalculatedFields
    TimeseriesAwareCalculatedFields
@@ -126,5 +133,6 @@ Methods for visualizing Evaluation data.
 .. autosummary::
    :template: custom-class-template.rst
    :toctree: generated
+   :nosignatures:
 
    TEEHRDataFrameAccessor

docs/sphinx/changelog/index.rst

@@ -1,17 +1,39 @@
 Release Notes
 =============
 
+0.4.8 - 2025-02-17
+------------------
+
+Added
+^^^^^
+- Adds box zoom to location plots.
+- Adds User Guide page for fetching NWM point data.
+- Adds new row level calculated fields, DayOfYear, ThresholdValueExceeded, ForecastLeadTime.
+
+
+Changed
+^^^^^^^
+- Changes NWM fetching methods from ``nwm_forecast_<xxxx>`` to ``nwm_operational_<xxxx>``.
+
+- Set ``use_table_schema`` to False when cloning the ``joined_timeseries`` table from s3,
+  so that extra fields will not be dropped. Note, this will raise an error if the table is
+  empty or does not exist.
+
+- Made auto-adding of configuration_name in NWM and USGS fetching optional.
+
+- Removed 2 evaluations from s3 (HEFS, NWM fetching), using TEEHR data module instead.
+
 
 0.4.7 - 2025-01-08
---------------------
+------------------
 
 Added
 ^^^^^
 * Adds RowLevelCalculatedFields and TimeseriesAwareCalculatedFields which are hopefully descriptive enough names.
 
 * Adds a User Guide page to describe what they are and how to use them.
 
-* Adds hvplot dependency to poerty
+* Adds hvplot dependency to poetry
 
 * Adds add_calculated_fields() methods to joined_timeseries and metrics "tables"
 

docs/sphinx/getting_started/index.rst

@@ -37,8 +37,8 @@ Or, if you do not want to install TEEHR in your own virtual environment, you can
 
 .. code-block:: bash
 
-   docker build -t teehr:v0.4.7 .
-   docker run -it --rm --volume $HOME:$HOME -p 8888:8888 teehr:v0.4.7 jupyter lab --ip 0.0.0.0 $HOME
+   docker build -t teehr:v0.4.8 .
+   docker run -it --rm --volume $HOME:$HOME -p 8888:8888 teehr:v0.4.8 jupyter lab --ip 0.0.0.0 $HOME
 
 Project Objectives
 ------------------

docs/sphinx/user_guide/notebooks/05_clone_from_s3.ipynb

@@ -60,7 +60,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Clone Evaluation Data form S3\n",
+    "### Clone Evaluation Data from S3\n",
     "As mentioned above, for this exercise we will be cloning a complete Evaluation dataset from the TEEHR S3 bucket.  First we will list the available Evaluations and then we will clone the `e0_2_location_example` evaluation which is  a small example Evaluation that only contains 2 gages."
    ]
   },
@@ -396,7 +396,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.15"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,

docs/sphinx/user_guide/notebooks/10_fetching_nwm_streamflow.ipynb

@@ -316,7 +316,7 @@
     "   :recursive:\n",
     "   :nosignatures:\n",
     "\n",
-    "    teehr.Fetch.nwm_forecast_grids\n",
+    "    teehr.Fetch.nwm_operational_grids\n",
     "    teehr.Fetch.nwm_retrospective_grids\n",
     "```\n",
     "\n",

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "teehr"
-version = "0.4.7"
+version = "0.4.8"
 description = "Tools for Exploratory Evaluation in Hydrologic Research"
 authors = [
     "RTI International",

src/teehr/__init__.py

@@ -1,5 +1,5 @@
 """Initialize the TEEHR package."""
-__version__ = "0.4.7"
+__version__ = "0.4.8"
 
 from teehr.evaluation.evaluation import Evaluation  # noqa
 from teehr.models.metrics.deterministic_models import DeterministicMetrics  # noqa
@@ -43,6 +43,4 @@
 from teehr.evaluation.tables.unit_table import UnitTable
 from teehr.evaluation.tables.variable_table import VariableTable
 from teehr.evaluation.fetch import Fetch  # noqa
-from teehr.visualization.dataframe_accessor import TEEHRDataFrameAccessor  # noqa
-from teehr.metrics import deterministic_funcs, signature_funcs, probabilistic_funcs # noqa
-from teehr.metrics.signature_funcs import count  # noqa
+from teehr.visualization.dataframe_accessor import TEEHRDataFrameAccessor  # noqa

version.txt

@@ -1 +1 @@
-0.4.7
+0.4.8