TimeSeries Class

Detailed Documentation

Example Usage

General

TimeSeries objects are named objects that represent time series in CWMS or DSS contexts.

Required Information

• location: Location

• parameter: Parameter

• parameter_type: ParameterType

• interval: Interval

• duration: Duration (CWMS context only)

• version: str (CWMS context only)

Optional Information

• watershed: str

• duration: Duration (DSS context only)

• version: str (DSS context only)

• data: pandas.DataFrame

Notes

A TimeSeries with a missing or empty _data [1] field is considered empty

The _data field has the following format:

• index: pandas.DatetimeIndex [2]

• "value" column: numpy.float64

• "quality" column: numpy.int64

[1]

The _data field is accessible through the data property.

[2]

The pandas.Timestamp type used by pandas.DatetimeIndex has a year range of approximately 1677..2262, which results in the inability of TimeSeries objects to include dates outside this range, which may occur in HEC-DSS files.