https://github.com/qba73/rivers
Go client library and CLI utility for reading water levels in Ireland
https://github.com/qba73/rivers
api geospatial gis gis-data gis-utils go ireland rivers sensors-data-collection
Last synced: 5 months ago
JSON representation
Go client library and CLI utility for reading water levels in Ireland
- Host: GitHub
- URL: https://github.com/qba73/rivers
- Owner: qba73
- License: mit
- Created: 2021-02-11T20:11:11.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-25T05:53:14.000Z (over 1 year ago)
- Last Synced: 2025-07-26T21:07:27.448Z (12 months ago)
- Topics: api, geospatial, gis, gis-data, gis-utils, go, ireland, rivers, sensors-data-collection
- Language: Go
- Homepage:
- Size: 2.86 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/qba73/rivers)
## rivers
```rivers``` is a Go client library and a CLI utility for reading water level and water temperature data from stations located in rivers in Ireland. The tool reads data from more than 450 sensors located in 28 rivers.
## Using the Go library
Import the library using:
```go
import "github.com/qba73/rivers"
```
## Creating a client
Creat a new ```Client``` object by calling ```rivers.NewClient()```:
```go
client := rivers.NewClient()
```
## Retrieving latest water level redings
```go
client.GetLatestWaterLevels()
```
or
```go
rivers.GetLatestWaterLevels()
```
## A complete example program
You can see an example programs which retrieves water level data in the [examples/stations](examples/stations/main.go) folder.
## Bugs and feature requests
If you find a bug in the ```rivers``` client or library, please [open an issue](https://github.com/qba73/rivers/issues). Similarly, if you'd like a feature added or improved, let me know via an issue.
Not all the functionality of the [water level](https://waterlevel.ie) is implemented yet.
Pull requests welcome!
## Using the CLI utility for reading water levels
Get readings from stations (water level in millimeters):
```
$ waterlevel
[...]
time: 2022-07-04 00:15:00 +0000 UTC, station: Innisconnell Pier, id: 36084, level: 1152
time: 2022-07-04 09:30:00 +0000 UTC, station: Clonconwal, id: 38001, level: 619
time: 2022-07-04 09:30:00 +0000 UTC, station: Glenties, id: 38010, level: 810
time: 2022-07-03 11:30:00 +0000 UTC, station: New Mills, id: 39001, level: 210
time: 2022-07-04 09:30:00 +0000 UTC, station: Tullyarvan, id: 39003, level: 327
[...]
```
Save readings to a file:
```
$ waterlevel > levels.txt
```
### Disclaimer
```rivers``` project processes *Irish Public Sector Information* licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0), [licence](http://waterlevel.ie) provided by the Office of Public Works.
Data is licensed under the [Creative Commons By Attribution (CC-BY) version 4.0 license](https://creativecommons.org/licenses/by/4.0/legalcode) - see [summary](https://creativecommons.org/licenses/by/4.0/).
This is in line with Irish Government [PER Circular 12 of 2016](http://circulars.gov.ie/pdf/circular/per/2016/12.pdf) and policy on Open Data [data.gov.ie](https://data.gov.ie/data).