TSTool / Command / ReadWaterML2
ReadWaterML2 command reads one or more time series from a WaterML 2 XML time series file
(see the WaterML2 Input Type Appendix).
WaterML files can be created using the
and can be saved from web sites that provide WaterML using the
See also the
ReadWaterML command, which reads older WaterML format.
Although WaterML 2 is intended to be a generally useful format for transferring time series data, its implementation by different organizations is not completely consistent and the specification allows some variability in the format. This causes issues for software like TSTool and consequently, a number of command parameters are implemented to allow control over handling different WaterML 2 "flavors". These issues need additional review, testing, and likely incremental software enhancements to ensure that the software can support WaterML 2 from various data providers.
The following dialog is used to edit the command and illustrates the command syntax.
ReadWaterML2 Command Editor for General Parameters (see also the full-size image)
ReadWaterML2 Command Editor for Instantaneous Data Parameters (see also the full-size image)
ReadWaterML2 Command Editor for Daily Data Parameters (see also the full-size image)
The command syntax is as follows:
||The name of the WaterML 2 file to read. The path to the file can be absolute or relative to the working directory.||None – must be specified.|
||Indicate the method by which to to read the file:
In both cases, it may be necessary to implement additional software logic to handle WaterML 2 from specific web services because organizations interpret the specification differently when publishing their data. TSTool has been developed mainly using WaterML 2 files from USGS NWIS services.
||The alias to assign to the time series, as a literal string or using the special formatting characters listed by the command editor. The alias is a short identifier used by other commands to locate time series for processing, as an alternative to the time series identifier (TSID).||No alias is assigned.|
||The data interval for the file, necessary because WaterML 2 does not have a data element that clearly indicates interval (time step for the data) and using irregular by default would be inefficient for data management. This issue is being further evaluated.||None – must be specified.|
||Indicate whether the date/time for each data value must align with the interval:
This parameter and the Interval parameter will continue to be evaluated.
Parameter is not used for irregular data.
||The start of the period to read data – specify if the period should be different from the global query period.||Use the global query period.|
||The end of the period to read data – specify if the period should be different from the global query period.||Use the global query period.|
||Offset in hours to adjust the times in the file to
||Use time zone in the file.|
||The output time zone string to use after applying
||Use time zone in the file.|
See the automated tests.