Skip to content

datastreamapp/wqx

Repository files navigation


Water Quality Exchange (WQX)
JSON Schema

Stars npm version npm downloads npm license

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:

In 2018, The Gordon Foundation 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).

DataStream (www.DataStream.org) 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

$ npm i wqx

Schemas

  • project
  • location
  • activitymetric
  • biological
  • biological-habitat
  • habitat
  • instantaneous
  • physical-chemistry

Use

const jsonschema = requrie('wqx/json-schema/biological');

Contributing

Building definitions.values.json

This should only be run if the version of WQX is updated.

$ curl https://cdx.epa.gov/wqx/download/DomainValues/All.zip
$ unzip All.zip
$ npm run build:values

Publishing

# update version in `package.json`
npm run build
cd dist
npm publish

Contributors

References

The Gordon Foundation Logo