Skip to content

Commit

Permalink
added initial hydroJSON.json file and updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GUNNAR A LEFFLER committed Jul 1, 2014
1 parent 462f8b5 commit 712f014
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
hydroJSON
=========

## v0.0.1 (June 10, 2014)
Initial cut from web conference discussion.

22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
hydroJSON
=========

## Synopsis
A JSON based standard for interchanging hydro, meteorological and environmental data.

## Code Example

Show what the library does as concisely as possible, developers should be able to figure out **how** your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

## Motivation

the purpose of hydroJSON is to standardize the interchange of timeseries data and metadata in a more modern, browser/mobile format.

## Installation


## API Reference


## Tests

Describe and show how to run the tests with code examples.

## Contributors

51 changes: 51 additions & 0 deletions hydroJSON.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
{
"STATION1": {
"description": "string",
"responsibility": "code or description of responsible office/database",
"coordinates": {
"latitude": "float",
"longitude": "float",
"datum": "string"
},
"HUC": "Numeric HUC Code",
"elevation": {
"value": "float",
"accuracy": "float",
"method": "full explanation"
},
"timezone": "US/Pacific full",
"time_format": "strftime/ISO-8601",
"TS_ID1": {
"values": [
[
"TIMESTAMP",
"VALUE"
],
[
"TIMESTAMP",
"VALUE"
]
],
"quality": [
[
"TIMESTAMP",
"VALUE"
],
[
"TIMESTAMP",
"VALUE"
]
],
"hash": "", //This was suggested by a modeler to easily compare if a dataset has already been seen
"parameter": "",
"duration": "",
"interval": "", //nominal frequency
"units": "",
"count": "integer",
"min_value": "float", //Should these be a timeslice e.g. [timestamp,value]?
"max_value": "float", //Should these be a timeslice e.g. [timestamp,value]?
"start_timestamp": "TIMESTAMP",
"end_timestamp": "TIMESTAMP"
}
}
}

0 comments on commit 712f014

Please sign in to comment.