You are not logged in. Click here to log in.

Application Lifecycle Management
CFA Time Series Analysis#6460/HEAD / v13
more
Tags:  not added yet

CFA Time Series Analysis[SERVICE-6460]

Tracker: Services Priority: NormalNormal Status: Deployed
Submitted by: wlloyd Jan 12 2016 11:03 Modified by: tcwible Jun 04 09:26 Type: Model
Path: m/cfa/timeseries Context: csip-cfa Version: 1.0
Endpoints: http://csip.engr.colostate.edu:8088/csip-cfa/m/cfa/timeseries/1.0
Maintainers: tcwible
Website: http://onewatersolutions.com/our-software/tools/water-quality Apps: --
Test Status: -- Last Tested: -- Test Count: --
Test Success Rate: -- Failed Tests: --
Traceability
Loading...
Description
The Time Series Analysis Tool graphs temporal changes in available flow or water quality data for any given station within the specified time period of interest. Time series also provides a summary of the statistics of the graphed data, including its min, max, median, mean, upper and lower quartiles, and standard deviation. A full statistical summary containing numerous hydrologic indicators of alteration (HIA) is also provided in a result file along with a graph of the data.

Notes about "wq_test":

- A complete list of water quality tests accepted by the databases accessed by this service is available here: https://www.waterqualitydata.us/public_srsnames/

- STORET water quality test names (wq_test) should match the format of Parm Code<space>Characteristic Name<space>--<space>units (i.e. "00600 Nitrogen, mixed forms (NH3), (NH4), organic, (NO2) and (NO3) -- mg/l")

- USGS water quality test names (wq_test) should match the format of Parm Code<space>Description<space>--<space>units (i.e. "00600 Total nitrogen (nitrate + nitrite + ammonia + organic-N), water, unfiltered, milligrams per liter -- mg/l")

Notes about Data Sources:

- All Data sources are accessed through the csip-lib-water library

- USGS Data extracted from the National Water Information System (NWIS) by encoded url (i.e. station id, begin/end dates, parameter type): https://help.waterdata.usgs.gov/faq/automated-retrievals

- STORET Data extracted from the Water Quality Data Portal (by the National Water Quality Monitoring Council) Web Services: https://www.waterqualitydata.us/webservices_documentation/

- CDWR Data extracted from the Colorado Decision Support System (CDSS) REST Services: http://dnrweb.state.co.us/dwr/dwrapiservice/help#TechInfoHelp&#All&#gettingstarted&#jsonxml

{
  "metainfo": {},
  "parameter": [
    {
      "name": "database",
      "description": "the database that the flow station belongs to (CDWR | STORET | USGS)",
      "value": "USGS"
    },
    {
      "name": "org_id",
      "description": "The ID for the supervising organization for the station within the STORET database (only used if database = 'STORET')",
      "value": "n\/a"
    },
    {
      "name": "station_id",
      "description": "station ID or name abbreviation used to query the specified database",
      "value": "06764880"
    },
    {
      "name": "station_name",
      "description": "Station name",
      "value": "South Platte River at Roscoe, Nebr."
    },
    {
      "name": "wq_test",
      "description": " The word 'flow' or the formatted name for the water quality test being used, Format is: '00600 Total nitrogen, water, unfiltered, milligrams per liter -- mg\/L' = '5-digit-USGS-water-quality-test-code test-name -- units'",
      "value": "flow"
    },
    {
      "name": "begin_date",
      "description": "Begin date of data analysis, blank or formatted yyyy-MM-dd",
      "value": ""
    },
    {
      "name": "end_date",
      "description": "End date of data analysis, blank or formatted yyyy-MM-dd",
      "value": ""
    },
    {
      "name": "time_step",
      "description": "Time step of analysis (Daily | Monthly | Yearly)",
      "value": "daily"
    },
    {
      "name": "method",
      "description": "Method of time step analysis (Max | Min | Average | Total)",
      "value": "Max"
    },
    {
      "name": "numBins",
      "description": "Number of bins for histogram graph",
      "value": 10
    },
    {
      "name": "logarithmicTF",
      "description": "If true, the bins of the histogram will be calculated logarithmically. If false, the bins of the histogram will be calculated arithmetically (equal spacing).",
      "value": false
    },
    {
      "name": "season_begin",
      "description": "Begin of Seasonal Analysis, formatted MM-dd (ex. June 1st would be entered as '06-01')",
      "value": "04-01"
    },
    {
      "name": "season_end",
      "description": "End of Seasonal Analysis, formatted MM-dd (ex. June 1st would be entered as '06-01')",
      "value": "09-30"
    },
    {
      "name": "period1_begin",
      "description": "Begin date of first period-based analysis (does not need to match data's begin_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "period1_end",
      "description": "End date of first period-based analysis (does not need to match data's end_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "period2_begin",
      "description": "Begin date of second period-based analysis (does not need to match data's begin_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "period2_end",
      "description": "End date of second period-based analysis (does not need to match data's end_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "period3_begin",
      "description": "Begin date of third period-based analysis (does not need to match data's begin_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "period3_end",
      "description": "End date of third period-based analysis (does not need to match data's end_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "medianTF",
      "description": "If true, the median value of period-based analyses will be graphed. If false, the average value of period-based analysis will be plotted",
      "value": false
    },
    {
      "name": "envelopeTF",
      "description": "If true and wq_test='flow', an envelope grpah will be generated, otherwise it will not be generated.",
      "value": false
    },
    {
      "name": "rasterTF",
      "description": "If true and wq_test='flow', a raster grpah (or pixel plot)(will be generated, otherwise it will not be generated.",
      "value": false
    },
    {
      "name": "rasterLogarithmicBinsTF",
      "description": "If true, the raster graph will use a logarithmic color scale otherwise it will use an arithmetic color scale. Only used if rasterTF is True and wq_test='flow'.",
      "value": false
    },
    {
      "name": "highPercentile",
      "description": "The percentile limit for defining 'high' flow pulses for analysis and statistics",
      "unit": "%",
      "value": 0.75
    },
    {
      "name": "lowPercentile",
      "description": "The percentile limit for defining 'low' flow pulses for analysis and statistics",
      "unit": "%",
      "value": 0.25
    },
    {
      "name": "calcFlowStatisticsFileTF",
      "description": "If true, and wq_test == 'flow', then a series of flow statistics will be calculated and returned in a flow statistics file. If false, no flow statistics file is created.",
      "value": true
    },
    {
      "name": "showMonthlyStatsTF",
      "description": "If true, and wq_test == 'flow', then monthly flow statistics will be included in the flow-statistics result file. If false, only annual and period of record statistics will be included.",
      "value": false
    },
    {
      "name": "calcCDPHElowflowTF",
      "description": "If true, and wq_test == 'flow', then design low-flow(s) will be calculated using the proceedure outlined by Colorado Division of Public Health and Environment's (CDPHE) DFLOW program and the inputs provided. If false, no CDPHE desing flow(s) will be calculated.",
      "value": false
    },
    {
      "name": "CDPHE_lowFlowType",
      "description": "The type of CDPHE low flow to be calculated, 'all' performs all the low flow calculations (all | extreme-value | biological | human-health | reg31). If using DFLOW is desired, prepend it to the previous options (i.e. dflow-all | dflow-extreme-value | dflow-biological | dflow-human-health) Only used if calcCDPHElowflowTF is True.",
      "value": "dflow-all"
    },
    {
      "name": "CDPHE_m",
      "description": "The m-day average to be taken (default for 'chronic' water quality criteria is 4 days, default for 'acute' water quality criteria is 1 day). Only used if calcCDPHElowflowTF is True and CDPHE_lowFlowType == 'all' or 'extreme-value' or 'biological'.",
      "unit": "days",
      "value": 4
    },
    {
      "name": "CDPHE_R",
      "description": "The return period of the design low flow to be calcualted. Only used if calcCDPHElowflowTF is True and CDPHE_lowFlowType == 'all' or 'extreme-value' or 'biological'.",
      "unit": "years",
      "value": 10
    },
    {
      "name": "CDPHE_waterYearBegin",
      "description": "Start date of the 'water year' to be analyzed, formatted MM-dd (ex. June 1st would be entered as '06-01'). Only used if calcCDPHElowflowTF is True and CDPHE_lowFlowType == 'all' or 'extreme-value'.",
      "value": "04-01"
    },
    {
      "name": "CDPHE_clusterLength",
      "description": "The length of an excursion 'cluster' of multiple low flow excursion periods (default is 120 days). Only used if calcCDPHElowflowTF is True and CDPHE_lowFlowType == 'all' or 'biological'.",
      "unit": "days",
      "value": 120
    },
    {
      "name": "CDPHE_clusterCountMax",
      "description": "The maximum number of low flow excursions counted per excursion cluster (default is 5). Only used if calcCDPHElowflowTF is True and CDPHE_lowFlowType == 'all' or 'biological'.",
      "unit": "",
      "value": 5
    },
    {
      "name": "merge_datasets",
      "description": "true if user data is provided and this dataset is to be merged with the public dataset, false if public or user data is to be analyzed alone (not merged)",
      "value": false
    },
    {
      "name": "merge_method",
      "description": "Method of merging the datasets, user data first, public data first, max, ave., min (user | public | max | average | min)",
      "value": "user"
    },
    {
      "name": "user_data",
      "description": "String containing user uploaded data with one line header (date,flow if wq_test = 'flow' otherwise: date,00600 which needs to match the 5-digit USGS water quality code provided in wq_test), first column dates (yyyy-mm-dd format), second column flow or water quality test values in a tab-delimited format. Only used if merge_datasets == 'true' or database == 'UserData'.",
      "value": ""
    }
  ]
}
{
  "metainfo": {
    "status": "Finished",
    "suid": "aeac8ac0-d981-11e5-988e-b1671f769ab8",
    "cloud_node": "172.1.6.246",
    "tstamp": "2016-02-22 09:31:10",
    "service_url": "http://csip.engr.colostate.edu:8082/csip-cfa/m/cfa/timeseries/1.0",
    "request_ip": "10.2.228.70",
    "cpu_time": 5036,
    "expiration_date": "2016-02-22 09:31:45"
  },
  "parameter": [
    {
      "name": "database",
      "description": "the database that the flow station belongs to (CDWR | STORET | USGS)",
      "value": "USGS"
    },
    {
      "name": "org_id",
      "description": "The ID for the supervising organization for the station within the STORET database (only used if database = 'STORET')",
      "value": "n/a"
    },
    {
      "name": "station_id",
      "description": "station ID or name abbreviation used to query the specified database",
      "value": "06764880"
    },
    {
      "name": "station_name",
      "description": "Station name",
      "value": "South Platte River at Roscoe, Nebr."
    },
    {
      "name": "wq_test",
      "description": " The word 'flow' or the formatted name for the water quality test being used, Format is: '00600 Total nitrogen, water, unfiltered, milligrams per liter -- mg/L' = '5-digit-USGS-water-quality-test-code test-name -- units'",
      "value": "flow"
    },
    {
      "name": "begin_date",
      "description": "Begin date of data analysis, blank or formatted yyyy-MM-dd",
      "value": ""
    },
    {
      "name": "end_date",
      "description": "End date of data analysis, blank or formatted yyyy-MM-dd",
      "value": ""
    },
    {
      "name": "time_step",
      "description": "Time step of analysis (Daily | Monthly | Yearly)",
      "value": "daily"
    },
    {
      "name": "method",
      "description": "Method of time step analysis (Max | Min | Average | Total)",
      "value": "Max"
    },
    {
      "name": "numBins",
      "description": "Number of bins for histogram graph",
      "value": 10
    },
    {
      "name": "logarithmicTF",
      "description": "If true, the bins of the histogram will be calculated logarithmically. If false, the bins of the histogram will be calculated arithmetically (equal spacing).",
      "value": false
    },
    {
      "name": "season_begin",
      "description": "Begin of Seasonal Analysis, formatted MM-dd (ex. June 1st would be entered as '06-01')",
      "value": "04-01"
    },
    {
      "name": "season_end",
      "description": "End of Seasonal Analysis, formatted MM-dd (ex. June 1st would be entered as '06-01')",
      "value": "09-30"
    },
    {
      "name": "period1_begin",
      "description": "Begin date of first period-based analysis (does not need to match data's begin_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "period1_end",
      "description": "End date of first period-based analysis (does not need to match data's end_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "period2_begin",
      "description": "Begin date of second period-based analysis (does not need to match data's begin_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "period2_end",
      "description": "End date of second period-based analysis (does not need to match data's end_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "period3_begin",
      "description": "Begin date of third period-based analysis (does not need to match data's begin_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "period3_end",
      "description": "End date of third period-based analysis (does not need to match data's end_date). If left blank, no period-based analysis will be performed.",
      "value": ""
    },
    {
      "name": "medianTF",
      "description": "If true, the median value of period-based analyses will be graphed. If false, the average value of period-based analysis will be plotted",
      "value": false
    },
    {
      "name": "envelopeTF",
      "description": "If true and wq_test='flow', an envelope grpah will be generated, otherwise it will not be generated.",
      "value": false
    },
    {
      "name": "rasterTF",
      "description": "If true and wq_test='flow', a raster grpah (or pixel plot)(will be generated, otherwise it will not be generated.",
      "value": false
    },
    {
      "name": "rasterLogarithmicBinsTF",
      "description": "If true, the raster graph will use a logarithmic color scale otherwise it will use an arithmetic color scale. Only used if rasterTF is True and wq_test='flow'.",
      "value": false
    },
    {
      "name": "highPercentile",
      "description": "The percentile limit for defining 'high' flow pulses for analysis and statistics",
      "unit": "%",
      "value": 0.75
    },
    {
      "name": "lowPercentile",
      "description": "The percentile limit for defining 'low' flow pulses for analysis and statistics",
      "unit": "%",
      "value": 0.25
    },
    {
      "name": "calcFlowStatisticsFileTF",
      "description": "If true, and wq_test == 'flow', then a series of flow statistics will be calculated and returned in a flow statistics file. If false, no flow statistics file is created.",
      "value": true
    },
    {
      "name": "showMonthlyStatsTF",
      "description": "If true, and wq_test == 'flow', then monthly flow statistics will be included in the flow-statistics result file. If false, only annual and period of record statistics will be included.",
      "value": false
    },
    {
      "name": "calcCDPHElowflowTF",
      "description": "If true, and wq_test == 'flow', then design low-flow(s) will be calculated using the proceedure outlined by Colorado Division of Public Health and Environment's (CDPHE) DFLOW program and the inputs provided. If false, no CDPHE desing flow(s) will be calculated.",
      "value": false
    },
    {
      "name": "CDPHE_lowFlowType",
      "description": "The type of CDPHE low flow to be calculated, 'all' performs all the low flow calculations (all | extreme-value | biological | human-health | reg31). If using DFLOW is desired, prepend it to the previous options (i.e. dflow-all | dflow-extreme-value | dflow-biological | dflow-human-health) Only used if calcCDPHElowflowTF is True.",
      "value": "dflow-all"
 }, { "name": "CDPHE_m", "description": "The m-day average to be taken (default for 'chronic' water quality criteria is 4 days, default for 'acute' water quality criteria is 1 day). Only used if calcCDPHElowflowTF is True and CDPHE_lowFlowType == 'all' or 'extreme-value' or 'biological'.", "unit": "days", "value": 4 }, { "name": "CDPHE_R", "description": "The return period of the design low flow to be calcualted. Only used if calcCDPHElowflowTF is True and CDPHE_lowFlowType == 'all' or 'extreme-value' or 'biological'.", "unit": "years", "value": 10 }, { "name": "CDPHE_waterYearBegin", "description": "Start date of the 'water year' to be analyzed, formatted MM-dd (ex. June 1st would be entered as '06-01'). Only used if calcCDPHElowflowTF is True and CDPHE_lowFlowType == 'all' or 'extreme-value'.", "value": "04-01" }, { "name": "CDPHE_clusterLength", "description": "The length of an excursion 'cluster' of multiple low flow excursion periods (default is 120 days). Only used if calcCDPHElowflowTF is True and CDPHE_lowFlowType == 'all' or 'biological'.", "unit": "days", "value": 120 }, { "name": "CDPHE_clusterCountMax", "description": "The maximum number of low flow excursions counted per excursion cluster (default is 5). Only used if calcCDPHElowflowTF is True and CDPHE_lowFlowType == 'all' or 'biological'.", "unit": "", "value": 5 }, { "name": "merge_datasets", "description": "true if user data is provided and this dataset is to be merged with the public dataset, false if public or user data is to be analyzed alone (not merged)", "value": false }, { "name": "merge_method", "description": "Method of merging the datasets, user data first, public data first, max, ave., min (user | public | max | average | min)", "value": "user" }, { "name": "user_data", "description": "String containing user uploaded data with one line header (date,flow if wq_test = 'flow' otherwise: date,00600 which needs to match the 5-digit USGS water quality code provided in wq_test), first column dates (yyyy-mm-dd format), second column flow or water quality test values in a tab-delimited format. Only used if merge_datasets == 'true' or database == 'UserData'.", "value": "" } ], "result": [ { "name": "len", "value": "11381" }, { "name": "start", "value": "1982-10-01" }, { "name": "end", "value": "2016-02-21" }, { "name": "units", "value": "cfs" }, { "name": "data_source", "value": "Stream flow data and water quality test data retrieved from the U.S. Geological Survey, National Water Information System: Web Interface. http://waterdata.usgs.gov/nwis, accessed: 2016-02-22 09:31" }, { "name": "max", "value": "18600.0", "unit": "cfs" }, { "name": "min", "value": "0.0", "unit": "cfs" }, { "name": "upperQuartile", "value": "760.0", "unit": "cfs" }, { "name": "lowerQuartile", "value": "67.0", "unit": "cfs" }, { "name": "median", "value": "231.0", "unit": "cfs" }, { "name": "mean", "value": "728.591", "unit": "cfs" }, { "name": "standardDeviation", "value": "1612.585", "unit": "cfs" }, { "name": "variance", "value": "2600430.009" }, { "name": "skewness", "value": "0.0" }, { "name": "coefficientOfVariation", "value": "2.213" }, { "name": "kendalCorrelationCoefficient", "value": "-0.1771" }, { "name": "len_seasonal", "value": "5673" }, { "name": "max_seasonal", "value": "18600.0", "unit": "cfs" }, { "name": "min_seasonal", "value": "0.0", "unit": "cfs" }, { "name": "upperQuartile_seasonal", "value": "593.5", "unit": "cfs" }, { "name": "lowerQuartile_seasonal", "value": "28.5", "unit": "cfs" }, { "name": "median_seasonal", "value": "150.0", "unit": "cfs" }, { "name": "mean_seasonal", "value": "909.59", "unit": "cfs" }, { "name": "standardDeviation_seasonal", "value": "2196.458", "unit": "cfs" }, { "name": "variance_seasonal", "value": "4824427.583" }, { "name": "skewness_seasonal", "value": "0.0" }, { "name": "coefficientOfVariation_seasonal", "value": "2.415" }, { "name": "kendalCorrelationCoefficient_seasonal", "value": "-0.1324" }, { "name": "flow_statistics_summary", "value": "flow_statistics.csv" }, { "name": "graph", "value": "timeseries_graph.jpg" }, { "name": "boxplot", "value": "timeseries_boxplot.jpg" }, { "name": "histogram", "value": "timeseries_histogram.jpg" }, { "name": "cdf_graph", "value": "timeseries_cdf.jpg" }, { "name": "monthlyAverage_graph", "value": "timeseries_monthlygraph.jpg" }, { "name": "graph_data_files", "value": "timeseries_graph.out|timeseries_boxplot.out|timeseries_monthlygraph.out|timeseries_histogram.outt|timeseries_cdf.out" }, { "name": "timeseries_graph.jpg", "value": "http://csip.engr.colostate.edu:8082/csip-cfa/q/aeac8ac0-d981-11e5-988e-b1671f769ab8/timeseries_graph.jpg" }, { "name": "timeseries_boxplot.jpg", "value": "http://csip.engr.colostate.edu:8082/csip-cfa/q/aeac8ac0-d981-11e5-988e-b1671f769ab8/timeseries_boxplot.jpg" }, { "name": "timeseries_monthlygraph.jpg", "value": "http://csip.engr.colostate.edu:8082/csip-cfa/q/aeac8ac0-d981-11e5-988e-b1671f769ab8/timeseries_monthlygraph.jpg" }, { "name": "timeseries_histogram.jpg", "value": "http://csip.engr.colostate.edu:8082/csip-cfa/q/aeac8ac0-d981-11e5-988e-b1671f769ab8/timeseries_histogram.jpg" }, { "name": "timeseries_cdf.jpg", "value": "http://csip.engr.colostate.edu:8082/csip-cfa/q/aeac8ac0-d981-11e5-988e-b1671f769ab8/timeseries_cdf.jpg" }, { "name": "timeseries_graph.out", "value": "http://csip.engr.colostate.edu:8082/csip-cfa/q/aeac8ac0-d981-11e5-988e-b1671f769ab8/timeseries_graph.out" }, { "name": "timeseries_boxplot.out", "value": "http://csip.engr.colostate.edu:8082/csip-cfa/q/aeac8ac0-d981-11e5-988e-b1671f769ab8/timeseries_boxplot.out" }, { "name": "timeseries_monthlygraph.out", "value": "http://csip.engr.colostate.edu:8082/csip-cfa/q/aeac8ac0-d981-11e5-988e-b1671f769ab8/timeseries_monthlygraph.out" }, { "name": "timeseries_histogram.outt", "value": "http://csip.engr.colostate.edu:8082/csip-cfa/q/aeac8ac0-d981-11e5-988e-b1671f769ab8/timeseries_histogram.outt" }, { "name": "timeseries_cdf.out", "value": "http://csip.engr.colostate.edu:8082/csip-cfa/q/aeac8ac0-d981-11e5-988e-b1671f769ab8/timeseries_cdf.out" }, { "name": "flow_statistics.csv", "value": "http://csip.engr.colostate.edu:8082/csip-cfa/q/aeac8ac0-d981-11e5-988e-b1671f769ab8/flow_statistics.csv" } ] 
}
 (none)
 timeseries_graph.jpg; timeseries_boxplot.jpg; timeseries_histogram.jpg; timeseries_monthlygraph.jpg; timeseries_cdf.jpg; timeseries_envelope.jpg; timeseries_raster.jpg; flow_statistics.csv;
Details
Staff
Comments & Attachments
Associations
Children
References
SCM Commits
History (13)
Baselines
All (13)

Filter
 
No data to display.