BritishGeologicalSurvey / sensor-things-api-demo

Jupyter notebook & web maps demonstrating BGS sensor data access via SensorThingsAPI

SensorThingsAPI demo

This repository contains examples for using the BGS Sensor Data service.

We have included a Jupyter notebook that demonstrates how to query and plot data from a SensorThingsAPI endpoint using Python. It is posted here to get users started with accessing environmental monitoring data from British Geological Survey sensors.These are published via an OGC SensorThingsAPI-compliant endpoint via the FROST Server software.

We have also included both Leaflet and OpenLayer web map examples:

• Leaflet web map, view the code, view online
• Openlayers web map, view the code, view online

BGS sensor data are available at https://sensors.bgs.ac.uk.

Follow the instructions below to install and run the demonstration Jupyter Notebook on your own machine. Alternatively, you can view the code and results in your browser. Click here for mobile-friendly version rendered by Jupyter nbviewer.

Prerequisites

• Python 3
• A Python 3 package manager e.g. pip3, conda

Installing dependencies

The following packages should be installed via pip3 or conda:

pip3 install -r requirements.txt

For developers

To test that the notebook runs to completion, extra packages are required:

pip3 install -r requirements-dev.txt

Run the test with:

pytest --nbval-lax sensor-things-api-demo.ipynb

Starting the notebook

The demo runs in a Jupyter notebook. Start the notebook with:

jupyter notebook

A browser window will open at http://localhost:8888 with a list of available notebooks.