{"id":13831833,"url":"https://github.com/htm-community/river-view","last_synced_at":"2026-02-19T21:58:25.455Z","repository":{"id":66661277,"uuid":"37883230","full_name":"htm-community/river-view","owner":"htm-community","description":"Public Temporal Streaming Data Service Framework","archived":false,"fork":false,"pushed_at":"2017-07-13T15:14:09.000Z","size":2571,"stargazers_count":28,"open_issues_count":34,"forks_count":16,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-08-05T10:19:11.981Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://data.numenta.org/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/htm-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2015-06-22T22:08:43.000Z","updated_at":"2019-08-18T16:46:55.000Z","dependencies_parsed_at":"2024-01-15T16:45:13.565Z","dependency_job_id":null,"html_url":"https://github.com/htm-community/river-view","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/htm-community%2Friver-view","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/htm-community%2Friver-view/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/htm-community%2Friver-view/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/htm-community%2Friver-view/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/htm-community","download_url":"https://codeload.github.com/htm-community/river-view/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225565935,"owners_count":17489288,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T10:01:41.599Z","updated_at":"2026-02-19T21:58:25.449Z","avatar_url":"https://github.com/htm-community.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# River View [![Build Status](https://travis-ci.org/nupic-community/river-view.svg)](https://travis-ci.org/nupic-community/river-view) [![Coverage Status](https://coveralls.io/repos/nupic-community/river-view/badge.svg?branch=master\u0026service=github)](https://coveralls.io/github/nupic-community/river-view?branch=master) [![Join the chat at https://gitter.im/nupic-community/river-view](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/nupic-community/river-view?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n\u003e Public Temporal Streaming Data Service Framework\n\n[![A View of the Mississippi River](https://raw.githubusercontent.com/nupic-community/river-view/master/site/images/river-view.jpg)](http://data.numenta.org)\n\n[See **River View** in action ⤤](http://data.numenta.org)\n\n\n_**River View**_ is a _Public Temporal Streaming Data Service Framework_ (yes, that's a mouthful!). It provides a pluggable interface for users to expose temporal data streams in a time-boxed format that is easily query-able. It was built to provide a longer-lasting historical window for public data sources that provide only real-time data snapshots, especially for sensor data from public government services like weather, traffic, and geological data.\n\n_River View_ fetches data from user-defined [_Rivers_](#Rivers) at regular intervals, populating a local [Redis](http://redis.io) database. This data is provided in a windowed format, so that data older than a certain configured age is lost. But the window should be large enough to provide enough historical data to potentially train machine intelligence models on the data patterns within it.\n\n## Video Introduction\n\n[![River View Video Thumbnail](http://img.youtube.com/vi/1niMh92IP-s/hqdefault.jpg)](https://www.youtube.com/watch?v=1niMh92IP-s)\n\u003e Watch [this short video](https://www.youtube.com/watch?v=1niMh92IP-s) for a quick introduction to River View.\n\n## Code Docs\n\nSee online documentation at \u003chttp://nupic-community.github.io/river-view/\u003e.\n\n## Dependencies\n\n- [Redis](http://redis.io)\n\nYou must have a Redis instance available. The URL to the instance should be set in an environment variable called `REDIS_URL`, something like:\n\n    export REDIS_URL=redis://127.0.0.1:6379\n\nYou may use authentication in the Redis URL string:\n\n    export REDIS_URL=redis://username:password@hostname:port\n\n## Rivers and Streams\n\nA _**River**_ is a pluggable collection of public data **Streams** gathered from one or more origins and collected in a query-able temporary temporal pool. _Rivers_ are declared within the [`rivers`](rivers) directory, and consist of:\n\n- a namespace, which is assumed based upon the directory name of the data source within the [`rivers`](rivers) directory\n- a YAML configuration file, containing:\n  - one or more external URLs where the data is collected, which are public and accessible without authentication\n  - the interval at which the data source will be queried\n  - when the data should expire\n- a JavaScript parser module that is passed the body of an HTTP call to the aforementioned URL(s), which is expected to parse it and return a temporal object representation of the data.\n\nEach _River_ may produce one or many _Streams_ of data, each collecting like data items over time. Each stream must have a unique ID, but all streams must use the same data schema (fields and meta data are defined at the River level).\n\nFor example, a city traffic data source may produce data streams for many traffic paths within the city, each identified with a unique stream ID. A US state water level data source might have unique sources for each water level sensor in the state, each with a unique stream ID.\n\n### River Types\n\nAll river streams must have a timestamp for each row of data. Other than that, they might have different primary types of data, as described below:\n\n- _spatial_: integer or float values\n- _geospatial_: latitude / longitude (floats)\n- _categorical_: string values\n\nThe data streams will be presented differently, both in JSON and HTML, depending on the type specified in the `config.yml` file.\n\n### Creating a River\n\nPlease see [Creating a River](https://github.com/nupic-community/river-view/wiki/Creating-a-River) in our wiki.\n\n## Web Services\n\nIn addition to collecting and storing data from _Rivers_, a simple HTTP API for reading the data is also active on startup. It returns HTML, JSON, and (in some cases) CSV data for each _River_ configured at startup.\n\n### URLs\n\n| URL | Description |\n| --- | ----------- |\n| `/index.[html|json]` | Current _Rivers_ active in **River View** |\n| `/\u003criver-name\u003e/props.[html|json]` | Detailed information about a _river_, including the URL to the river's keys |\n| `/\u003criver-name\u003e/keys.[html|json]` | All unique ids for data within _river_ |\n| `/\u003criver-name\u003e/\u003cid\u003e/data.[html|json|csv]` | All data for specified key |\n| `/\u003criver-name\u003e/\u003cid\u003e/meta.[html|json]` | All metadata for specified key |\n\n### Running Locally (on OS X)\nOS X has some weird built in behaviors regarding the maximum number of open file descriptors. River-view\nneeds the system to handle around 1024 open descriptors to actually start up, so if you run into any sort of\n*file-can't-be-opened* errors, check that you have an appropriate number of maximum open file descriptors by\nrunning `ulimit -n`. If this number is less than 1024, you'll need to update it.\n\n## Updating the maximum number of open file descriptors\n- ```sudo launchctl limit maxfiles 1024 unlimited```\n\nThis updates the maximum number of open file descriptors your Mac will allow. This number is not persistant across reboots. To make it persistant add `limit maxfiles 1024 unlimited` to `/etc/launchd.conf`\n- ```ulimit -n 1024```\n\nThis updates the current shell you're in to be able to make use of all those file descriptors.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhtm-community%2Friver-view","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhtm-community%2Friver-view","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhtm-community%2Friver-view/lists"}