Merge pull request #361 from RTIInternational/229-investigate-ensemble-evaluation-methods

229 investigate ensemble evaluation methods

Author: samlamont

.gitignore

@@ -72,7 +72,7 @@ instance/
 docs/sphinx/_build/
 docs/sphinx/_autosummary/
 docs/sphinx/_static/*.html
-docs/sphinx/generated/
+docs/sphinx/api/generated/
 docs/sphinx/savefig/
 docs/sphinx/getting_started/test_data/temp_test.db
 docs/sphinx/jupyter_execute/

README.md

@@ -37,8 +37,8 @@ python -m teehr.utils.install_spark_jars
 ```
 Use Docker
 ```bash
-$ docker build -t teehr:v0.4.6 .
-$ docker run -it --rm --volume $HOME:$HOME -p 8888:8888 teehr:v0.4.6 jupyter lab --ip 0.0.0.0 $HOME
+$ 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
 ```
 
 ## Examples

docs/sphinx/_templates/autoapi/index.rst

@@ -5,7 +5,6 @@
 .. autoclass:: {{ objname }}
    :members:
    :show-inheritance:
-   :inherited-members:
    :special-members: __call__, __add__, __mul__
 
    {% block methods %}

docs/sphinx/_templates/custom-class-template.rst

@@ -1,7 +1,7 @@
-.. currentmodule:: teehr
-
 .. _api:
 
+.. currentmodule:: teehr
+
 #############
 API reference
 #############
@@ -24,7 +24,7 @@ The top-level class for interacting with and exploring a TEEHR Evaluation.
 
 
 Creating and Managing an Evaluation
-------------------------------------
+-----------------------------------
 
 Methods for creating, cloning, and configuring an Evaluation.
 
@@ -74,16 +74,19 @@ Methods for fetching NWM and USGS data from external sources.
    Fetch.nwm_forecast_grids
 
 
-Metric Queries
---------------
+Metric Functions
+----------------
 
-Methods for querying and calculating metrics.
+Functions for calculating metrics.
 
 .. autosummary::
-   :template: custom-class-template.rst
    :toctree: generated
+   :template: custom-module-template.rst
+   :recursive:
 
-   evaluation.metrics.Metrics
+   deterministic_funcs
+   signature_funcs
+   probabilistic_funcs
 
 
 Metric and Bootstrap Models
@@ -92,12 +95,27 @@ Metric and Bootstrap Models
 Classes for defining and customizing metrics and bootstrap models.
 
 .. autosummary::
-   :template: custom-module-template.rst
    :toctree: generated
+   :template: custom-class-template.rst
+   :recursive:
+
+   DeterministicMetrics
+   SignatureMetrics
+   ProbabilisticMetrics
+   Bootstrappers
+
+
+Calculated Field Models
+-------------------------
+
+Classes for defining and customizing user-defined field models.
+
+.. autosummary::
+   :toctree: generated
+   :template: custom-class-template.rst
 
-   metric_models
-   bootstrap_models
-   metric_funcs
+   RowLevelCalculatedFields
+   TimeseriesAwareCalculatedFields
 
 
 Visualization