Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datastreamapp/wqx
Water Quality Exchange (WQX) JSON Schema
https://github.com/datastreamapp/wqx
json-schema wqx
Last synced: 3 months ago
JSON representation
Water Quality Exchange (WQX) JSON Schema
- Host: GitHub
- URL: https://github.com/datastreamapp/wqx
- Owner: datastreamapp
- License: mit
- Created: 2018-02-15T21:04:11.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-05-18T00:22:51.000Z (7 months ago)
- Last Synced: 2024-05-18T01:26:16.890Z (7 months ago)
- Topics: json-schema, wqx
- Language: JavaScript
- Homepage:
- Size: 223 MB
- Stars: 4
- Watchers: 7
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Water Quality Exchange (WQX)
JSON Schema
## Background
The WQX standard for the Exchange of Water Quality Data was developed by the US Environmental Protection Agency (EPA) and the US Geological Society (USGS) and is an implementation of the ESAR (Environmental Sampling, Analysis and Results) data standard.
The Gordon Foundation transformed the WQX from its original XML format to json table schema.This was done using resources available on the following site:
- https://www.epa.gov/waterdata/water-quality-data-wqx
- http://www.exchangenetwork.net/data-exchange/wqx/
- https://www3.epa.gov/storet/archive/web/wqx.html
In 2018, [The Gordon Foundation](http://gordonfoundation.ca) led a comprehensive review process to determine how this model could be adapted to best meet the needs of diverse water monitoring initiatives in Canada. The result is DataStream’s WQX Open Data Schema ([DS-WQX](https://github.com/gordonfn/schema)).
DataStream ([www.DataStream.org](http://gordonfoundation.ca/initiatives/datastream)) is an online open-access platform for sharing water quality data in Canada. It was developed by The Gordon Foundation and carried out in collaboration with regional partners and monitoring networks.
## Install
```bash
$ npm i wqx
```
## Schemas
- `project`
- `location`
- `activitymetric`
- `biological`
- `biological-habitat`
- `habitat`
- `instantaneous`
- `physical-chemistry`
## Use
```javascript
const jsonschema = requrie('wqx/json-schema/biological');
```
## Contributing
### Building `definitions.values.json`
This should only be run if the version of WQX is updated.
```bash
$ curl https://cdx.epa.gov/wqx/download/DomainValues/All.zip
$ unzip All.zip
$ npm run build:values
```
### Publishing
```bash
# update version in `package.json`
npm run build
cd dist
npm publish
```
### Contributors
- [willfarrell](https://github.com/willfarrell)
## References
- [US EPA WQX](https://www.epa.gov/waterdata/water-quality-data-wqx)
- [Web Template Files](https://www.epa.gov/waterdata/water-quality-exchange-web-template-files)
- [Schema (XML)](http://www.exchangenetwork.net/data-exchange/wqx/)
- [Schema Allowed Values](https://www.epa.gov/waterdata/storage-and-retrieval-and-water-quality-exchange-domain-services-and-downloads#domain)
- [US EPA WQX Historical](https://www3.epa.gov/storet/archive/web/wqx.html)
