tsgettoolbox.tsgettoolbox.hydstra_ts

tsgettoolbox.tsgettoolbox.hydstra_ts(server, station, variable, start_time, end_time, interval='day', provisional=False, datasource=None, aggcode=None, quality=False, maxqual=254)

global:station:::Kisters Hydstra Webservice - time series values

Hydstra databases are generally organized into stations, datasources, and variables.

Parameters:

server –

Server name or base URL of Hydstra webserver. This can be either a direct URL (normally up to but not including a ‘?’) or it can be one of the following predetermined server names.

Name	Description
sjrwmd	St. Johns Water Management District, Florida, USA https://secure.sjrwmd.com/hydweb/cgi/webservice.exe
orangeco_ca	Orange County Public Works, California USA http://Hydstra.OCPublicWorks.com/cgi/webservice.exe

station

This should be the short ‘station identifier’, not the longer ‘station name’.

variable

Name of variable or numeric variable code. The list of available variables varies by server. The following is a typical list of names and their associated numeric codes:

Rainfall:in:             11.10
Water_Elev_NAVD88:ft:   227.10
Gauge Height:ft:        233.10
Discharge:cfs:          262.17

Other available variable codes for a given station can be determined using the hydstra_catalog command.

start_time

Date and time for start of requested period in ISO format. For daily and longer intervals, use YYYY-MM-DD. For sub-daily, use YYYY-MM-DD-hh-mm or YYYY-MM-DD-hh-mm-ss if necessary.

end_time

Date and time for end of requested period in ISO format. For daily and longer intervals, use YYYY-MM-DD. For sub-daily, use YYYY-MM-DD-hh-mm or YYYY-MM-DD-hh-mm-ss if necessary.

interval

Time step of data to return. Valid values are: year, month, day, hour, minute, second

provisional

Boolean: False (default) to skip provisional data. True to include it. In many cases, this means datasources A and AB respectively. Details may vary by server.

datasource

Hydstra databases include an attribute called ‘datasource’. A given variable may be present as multiple timeseries with different datasources, each with various available periods of record and levels of quality assurance.

For some servers, certain datasources are reserved for internal workflows and may be skipped by the hydstra_catalog command.

Default is ‘A’ (for ‘Archive’) if not including provisional data. The default for provisional data may vary by server. For instance:

sjrwmd          The default for including recent non-QA'ed
                provisional data is 'AB', which returns the full
                span, distinguished by different quality codes.  To
                get only the provisional data, the 'X' datasource
                would be used. There may be overlap in the time
                spans of 'A' and 'X', during which the 'A' should
                be preferred.

orangeco_ca     There is no 'AB' datasource.  The 'TELEMETRY'
                datasource contains the provisional data, which can
                overlap with the 'A' datasource

Required if provisional data is requested.

aggcode

Aggregation code. defaults to ‘tot’ for rainfall, ‘mean’ for elevation and discharge. Other values vary by server. Required if variable specified by numeric code.

quality

Boolean: False (default) provides no quality information. True to add a column containing a numeric quality code 0 to 255. Definitions of codes may vary by server.

maxqual

Highest allowable numeric quality code, above which the value is considered missing. May be specified even if a separate quality column is not requested.