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
To obtain parameter summary or time series data, use
45
+
```
46
+
die weave {parameter}
47
+
```
48
+
49
+
where `{parameter}` is the name of the parameter whose data is to be retrieved, followed by the desired output type, excluded data sources, date filters, and geographic filters. `{parameter}` is case-insensitive.
50
+
51
+
52
+
#### Available Parameters
53
+
The following parameters are currently available for retrieval:
54
+
- waterlevels
55
+
- arsenic
56
+
- bicarbonate
57
+
- calcium
58
+
- carbonate
59
+
- chloride
60
+
- magnesium
61
+
- nitrate
62
+
- ph
63
+
- potassium
64
+
- silica
65
+
- sodium
66
+
- sulfate
67
+
- tds
68
+
- uranium
69
+
70
+
#### Source Inclusion & Exclusion
41
71
The Data Integration Engine enables the user to obtain groundwater level and groundwater quality data from a variety of sources. Data from sources are automatically included in the output if available unless specifically excluded. The following flags are available to exclude specific data sources:
42
72
43
73
-`--no-bernco` to exclude Bernalillo County (BernCo) data
@@ -50,81 +80,63 @@ The Data Integration Engine enables the user to obtain groundwater level and gro
50
80
-`--no-pvacd` to exclude Pecos Valley Artesian Convservancy District (PVACD) data
51
81
-`--no-wqp` to exclude Water Quality Portal (WQP) data
52
82
53
-
###Water Levels
83
+
#### Geographic Filters
54
84
55
-
To obtain groundwater levels, use
85
+
The following flags can be used to geographically filter data:
56
86
57
87
```
58
-
weave Waterlevels
88
+
-- county {county name}
59
89
```
60
90
61
-
followed by the desired output type, source filters, date filters, geographic filters, and excluded data sources.
62
-
63
-
### Water Quality
64
-
To obtain groundwater quality, use
65
-
66
91
```
67
-
weave {analyte}
92
+
-- bbox 'x1 y1, x2 y2'
68
93
```
69
94
70
-
where `{analyte}` is the name of the analyte whose data is to be retrieved.
71
-
72
-
#### Available Analytes
73
-
The following analytes are currently available for retrieval:
74
-
- Arsenic
75
-
- Bicarbonate
76
-
- Calcium
77
-
- Carbonate
78
-
- Chloride
79
-
- Magnesium
80
-
- Nitrate
81
-
- pH
82
-
- Potassium
83
-
- Silica
84
-
- Sodium
85
-
- Sulfate
86
-
- TDS
87
-
- Uranium
95
+
#### Date Filters
88
96
89
-
### Geographic Filters
90
-
91
-
The following flags can be used to geographically filter data:
97
+
The following flags can be used to filter by dates:
92
98
93
99
```
94
-
-- county {county name}
100
+
--start-date YYYY-MM-DD
95
101
```
96
102
97
103
```
98
-
-- bbox 'x1 y1, x2 y2'
104
+
--end-date YYYY-MM-DD
99
105
```
100
106
101
-
### Date Filters
102
-
103
-
The following flags can be used to filter by dates:
107
+
#### Output
108
+
The following flags are used to set the output type:
104
109
105
110
```
106
-
--start-date YYYY-MM-DD
111
+
--output summary
107
112
```
113
+
- A summary table consisting of location information as well as summary statistics for the parameter of interest for every location that has observations.
108
114
109
115
```
110
-
--end-date YYYY-MM-DD
116
+
--output timeseries_unified
111
117
```
118
+
- A single table consisting of time series data for all locations for the parameter of interest.
119
+
- A single table of site data that contains information such as latitude, longitude, and elevation
112
120
113
-
## Output
114
-
The data is saved to the current working directory. A log of the inputs and processes, called `die.log`, is also saved to the current working directory. If a subsquent process is run and the log from the previous process has not been moved or stored elsewhere, the log for the subsequent process will be appended to the existing log.
121
+
```
122
+
--output timeseries_separated
123
+
```
124
+
- Separate time series tables for all locations for the parameter of interest.
125
+
- A single table of site data that contains information such as latitude, longitude, and elevation
115
126
116
-
### Timeseries Data
117
-
The flag `--separated_timeseries` exports timeseries for every location in their own file in the directory output_series (e.g. `AB-0002.csv`, `AB-0003.csv`).
127
+
The data is saved to a directory titled `output` in the current working directory. If the directory `output` already exists, then the output directory will be called `output_1`. If enumerated output directories already exist, then the output directory will be called `output_{n}` where `n` is equal to the greatest integer suffix +1.
118
128
119
-
The flag `--unified_timeseries` exports all timeseries for all locations in one file titled `output.timeseries.csv`.
129
+
A log of the inputs and processes, called `die.log`, is also saved to the output directory.
120
130
121
-
Both time series export a file titled `output.sites.csv` that contains site information, such as latitude, longitude, and elevation.
131
+
##### Timeseries Data
122
132
123
-
#### Table Headers
133
+
**sites**
124
134
125
-
The table headers for timeseries data are as follows:
135
+
| a | source | id | name | latitude | longitude | elevation | elevation_units | horizontal_datum | vertical_datum | usgs_site_id | alternate_site_id | formation | aquifer | well_depth |
| description | the organization/source for the site | the id of the site. The id is used as the key to join the site and timeseries tables | the colloquial name for the site if it exists | latitude in decimal degrees | longitude in decimal degrees | ground surface elevation of the site in feet | the units of the ground surface elevation. Defaults to ft | horizontal datum of the latitude and longitude. Defaults to WGS84 | vertical datum of the elevation | USGS site id if it exists | alternate side id if it exists | geologic formation in whch the well terminals if it exists | aquifer from which the well draws water if it exists | depth of well if it exists |
-`id`: the id of the site. The id is used as the key to join the output.timeseries.csv table
130
142
-`name`: the colloquial name for the site if it exists
@@ -140,14 +152,8 @@ The table headers for timeseries data are as follows:
140
152
-`aquifer`: aquifer from which the well draws water if it exists
141
153
-`well_depth`: depth of well if it exists
142
154
143
-
**output.timeseries.csv - waterlevels**
144
-
-`source`: the organization/sources for the site
145
-
-`id`: the id of the site. The id is used as the key to join the output.sites.csv table
146
-
-`depth_to_water_ft_below_ground_surface`: depth to water below ground surface in ft
147
-
-`date_measured`: date of measurement in YYYY-MM-DD format
148
-
-`time_measured`: time of measurement if it exists
149
155
150
-
**output.timeseries.csv - analytes**
156
+
**time series**
151
157
-`source`: the organization/sources for the site
152
158
-`id`: the id of the site. The id is used as the key to join the output.sites.csv table
153
159
-`parameter`: the name of the analyte whose measurements are reported in the table. This corresponds the requested analyte
@@ -158,7 +164,7 @@ The table headers for timeseries data are as follows:
158
164
159
165
### Summary Data
160
166
161
-
If neither of the above flags are specified, a summary table called `output.csv` is exported. The summary table consists of location information as well as summary statistics for the parameter of interest for every location that has observations.
167
+
If neither of the above flags are specified, a summary table called `output.csv` is exported.
0 commit comments