You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/design/composite-time-series.rst
+23-13Lines changed: 23 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,15 +7,15 @@ Purpose
7
7
8
8
It is a challenge for users to identity what the correct authoritative time series is for a given measurement at a location. Additionally these time series often change over time, either being completely new or changing their interval as newer technologies become available.
9
9
10
-
Gather an entire Period of Record for the value at a location is also rather difficult. And the POR record and "authoritative timeseries" may be one-in-the same.
10
+
Gather an entire Period of Record for the value at a location is also rather difficult. And the Period of Record (POR) and "authoritative timeseries" may be one-in-the same.
11
11
12
12
13
13
Need
14
14
====
15
15
16
16
#. CWMS and Access-2-Water require a simple mechanism to allow users of data to retrieve the Authoritative Period of Record data for a given measurement without having to understand all of the possible component time series that may be involved.
17
17
#. Period-of-Record time series *should* not be created by duplicating data from the component time series and merging them into a new one.
18
-
#. The naming of the time series should fit within the excepting CWMS Time Series Identifier design and not unreasonably interfere with existing usages.
18
+
#. The naming of the time series should fit within the existing CWMS Time Series Identifier design and not unreasonably interfere with existing usages.
19
19
20
20
21
21
Caveats
@@ -31,9 +31,9 @@ Proposal
31
31
Description
32
32
-----------
33
33
34
-
CDA should handle a concept of a "Composite Time Series". Whether a Time Series is considered composite will be determined by a specific element of the Time Series Identifier.
34
+
CWMS-Data-API (CDA) should handle a concept of a "Composite Time Series". Whether a Time Series is considered composite will be determined by some means (see naming options below).
35
35
Data Administrators will configure which Time Series, and the range there-in, are part of the composite time series.
36
-
CDA will use this stored information to build the Time Series per the question.
36
+
CDA will use this composite time series definition to build an expand Time Series per query for the range of time requested.
37
37
38
38
Additional names not used
39
39
-------------------------
@@ -53,8 +53,10 @@ Axioms
53
53
#. The definition of the composite time series is stored within the CWMS database
54
54
#. The members of a composite time series define a continuous range
55
55
#. The date ranges of a member *MUST* not overlap
56
-
#. The date ranges of a member *MUST* not have any gaps
57
-
#. Data may have gaps, an explanation range should be provided.
56
+
#. Each member *MUST* have a start date
57
+
#. The last member *MAY* have an end date indicating no more data will be available for this location and measure.
58
+
#. Data may have gaps, an explanation range *SHOULD* be provided. For data with regular gaps, e.g. season gauges
59
+
a description should be provided in the notes. A Link to a Location Level can be provided if the timing is well known.
58
60
#. The members of a composite time measure the same thing. (e.g. all members are Elevation, not some are elevation and some are stage.)
59
61
#. The interval and duration of each member *MAY* be different.
60
62
@@ -163,8 +165,8 @@ Option 4
163
165
This form with something in [] has been discussed for embedded TimeZone and Offset information into the interval. Arguably this code go in any field.
0 commit comments