Skip to content

Commit 08a0aeb

Browse files
committed
update documentation
1 parent ada99cb commit 08a0aeb

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
## Unreleased: 0.9.0
7+
## 0.9.2
88

99
### Added
1010
- `--sites-only` flag to only retrieve site data
1111
- `--output-format` flag to write out sites/summary tables as csv or geojson.
1212
- options are `csv` or `geojson`
13+
- timeseries data is always written to a csv
1314
- NM OSE POD data for sites.
1415
- can be removed from output with `--no-nmose-pod`
1516
- `--output-dir` to change the output directory to a location other than `.` (the current working directory)

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,22 +71,22 @@ where `{parameter}` is the name of the parameter whose data is to be retrieved,
7171
| **pvacd** | X | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - |
7272
| **wqp** | X | X | X | X | X | X | X | X | X | X | X | X | X | X | X | X |
7373

74-
### Output
75-
The `--output` option is required and used to set the output type:
74+
### Output Type
75+
The `--output-type` option is required and used to set the output type:
7676

7777
```
78-
--output summary
78+
--output-type summary
7979
```
8080
- A summary table consisting of location information as well as summary statistics for the parameter of interest for every location that has observations.
8181

8282
```
83-
--output timeseries_unified
83+
--output-type timeseries_unified
8484
```
8585
- A single table consisting of time series data for all locations for the parameter of interest.
8686
- A single table of site data that contains information such as latitude, longitude, and elevation
8787

8888
```
89-
--output timeseries_separated
89+
--output-type timeseries_separated
9090
```
9191
- Separate time series tables for all locations for the parameter of interest.
9292
- A single table of site data that contains information such as latitude, longitude, and elevation
@@ -181,7 +181,7 @@ The Data Integration Engine enables the user to obtain groundwater level and gro
181181
- `--no-pvacd` to exclude Pecos Valley Artesian Convservancy District (PVACD) data
182182
- `--no-wqp` to exclude Water Quality Portal (WQP) data
183183

184-
### Geographic Filters
184+
### Geographic Filters [In Development]
185185

186186
The following flags can be used to geographically filter data:
187187

@@ -193,7 +193,11 @@ The following flags can be used to geographically filter data:
193193
-- bbox 'x1 y1, x2 y2'
194194
```
195195

196-
### Date Filters
196+
```
197+
-- wkt {wkt polygon or multipolygon}
198+
```
199+
200+
### Date Filters [In Development]
197201

198202
The following flags can be used to filter by dates:
199203

0 commit comments

Comments
 (0)