From 712f014134b620cc94577c2a2327c4fd21cf2fda Mon Sep 17 00:00:00 2001 From: GUNNAR A LEFFLER Date: Tue, 1 Jul 2014 00:32:53 +0000 Subject: [PATCH] added initial hydroJSON.json file and updated README.md --- CHANGELOG.md | 6 ++++++ README.md | 22 ++++++++++++++++++++++ hydroJSON.json | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 79 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 hydroJSON.json diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..edfed52 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +hydroJSON +========= + +## v0.0.1 (June 10, 2014) +Initial cut from web conference discussion. + diff --git a/README.md b/README.md index a511d58..65d39a6 100644 --- a/README.md +++ b/README.md @@ -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 + diff --git a/hydroJSON.json b/hydroJSON.json new file mode 100644 index 0000000..f34d7fe --- /dev/null +++ b/hydroJSON.json @@ -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" + } + } +}