API reference

The Evaluation Dataset

The top-level classes for interacting with and managing a TEEHR Evaluation.

Evaluation Classes

• Evaluation - Main local read-write evaluation class

• LocalReadWriteEvaluation - Explicit local read-write class

• RemoteReadOnlyEvaluation - Read-only access to remote catalogs

• RemoteReadWriteEvaluation - Read-write access to remote catalogs

Tables

• Attributes Table

• Configurations Table

• Units Table

• Variables Table

• Location Attribute Table

• Location Crosswalk Table

• Locations Table

• Primary Timeseries Table

• Secondary Timeseries Table

• Base Table

Views

• Base View

• Joined Timeseries View

• Location Attributes View

• Primary Timeseries View

• Secondary Timeseries View

Data I/O

Classes and methods related to data input and output.

• Fetching USGS and NWM Data

• Downloading Data from TEEHR Warehouse

• Reading Data

• Writing Data

• Loading Data

• Extracting Data

• Validating Data

Analysis & Metrics

Tools for calculating metrics and generating synthetic timeseries.

Metrics

• The Metrics Class (deprecated - use query() on tables/views)

• Row-Level Calculated Fields

• Timeseries-Aware Calculated Fields

• Deterministic Functions

• Signature Functions

• Probabilistic Functions

• Bootstrap Functions

• Deterministic Metrics Models

• Probabilistic Metrics Models

• Signature Models

• Bootstrappers

• Operators

Migration note:

• Calculated fields modules were renamed to explicit model paths:

  row_level -> models.row_level, timeseries_aware -> models.timeseries_aware.

• Metrics basemodels module was renamed:

  basemodels -> models.base.

• Top-level imports from teehr (for example DeterministicMetrics and calculated-fields containers) are unchanged.

Generated Timeseries

• Generated Timeseries

• Streamflow Normals

• Reference Forecast Model

• Persistence Forecast Model