Skip to content

Commit

Permalink
Documentation: Add a bit eye candy to the landing page; Improve gallery
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Dec 19, 2022
1 parent cfd2df7 commit 11a68c4
Show file tree
Hide file tree
Showing 3 changed files with 115 additions and 7 deletions.
4 changes: 2 additions & 2 deletions doc/backlog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -285,8 +285,8 @@ Documentation
- [x] Interlink with forum
- [/] Use sphinx-inline-tabs
- [x] Add sphinxext-opengraph
- [o] Improve gallery
- [o] Add a bit of eye candy to landing page
- [x] Improve gallery
- [x] Add a bit of eye candy to the landing page


****
Expand Down
91 changes: 87 additions & 4 deletions doc/gallery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,14 @@ Some example installations, usually running live data feeds through them.
**************
luftdaten.info
**************
Implemented by `luftdaten_info.py <https://github.com/earthobservations/luftdatenpumpe/blob/0.11.0/luftdatenpumpe/source/luftdaten_info.py>`_

About
=====
Acquisition of sensor data from the LDI network.

Adapter
=======
Implemented by `luftdatenpumpe.source.luftdaten_info <https://github.com/earthobservations/luftdatenpumpe/blob/main/luftdatenpumpe/source/luftdaten_info.py>`_

Dashboards
==========
Expand All @@ -19,6 +26,23 @@ Dashboards
- `LDI Karte und Kompensation <https://weather.hiveeyes.org/grafana/d/FUygU7_mk/wtf-ldi-karte-und-kompensation-dev>`_
- `LDI Feuchtekorrektur PM10 <https://weather.hiveeyes.org/grafana/d/IgmFilaiz/wtf-pm10-feuchtekorrektur-ldi>`_

Screenshots
===========

.. figure:: https://ptrace.hiveeyes.org/2018-12-28_luftdaten-info-coverage.gif
:target: https://ptrace.hiveeyes.org/2018-12-28_luftdaten-info-coverage.mp4
:alt: Coverage of LDI network 2015-2018.

`Coverage of LDI network 2015-2018 <https://github.com/panodata/grafanimate#luftdateninfo-coverage>`_

.. figure:: https://ptrace.hiveeyes.org/2019-02-03_particulates-on-new-year-s-eve.gif
:target: https://ptrace.hiveeyes.org/2019-02-03_particulates-on-new-year-s-eve.mp4
:alt: Fine dust pollution on New Year's Eve 2018.

`Fine dust pollution on New Year's Eve 2018 <https://github.com/panodata/grafanimate#fine-dust-pollution-on-new-years-eve>`_
|
`Animation of fine dust pollution on New Year's Eve 2018 across Europe <https://community.hiveeyes.org/t/animation-der-feinstaubbelastung-an-silvester-2018-mit-grafanimate/1472>`_

References
==========
- https://web.archive.org/web/20220604103954/https://luftdaten.info/
Expand All @@ -35,20 +59,79 @@ Labs
- `LDI Demo #5 » Map by location and sensor type <https://weather.hiveeyes.org/grafana/d/9d9rnePmk/amo-ldi-stations-5-map-by-sensor-type>`_


*****
DHT22
*****

About
=====

An analysis of the results of DHT22 humidity sensors.

Screenshots
===========

.. figure:: https://community.panodata.org/uploads/default/original/1X/41fd0e21e8f252c9843d73c6267d2436ea9f3391.png
:target: https://community.panodata.org/t/data-crunching-and-visualization/108
:alt: Analyzing DHT22 measurement values on the LDI network.

Analyzing DHT22 measurement values on the LDI network.


********
IRCELINE
********
Implemented by `irceline.py <https://github.com/earthobservations/luftdatenpumpe/blob/0.11.0/luftdatenpumpe/source/irceline.py>`_

About
=====
Air quality monitoring for the Flanders Environment Agency in Belgium.

Luftdatenpumpe helped VMM to support their work for the Belgian Interregional
Environment Agency (IRCEL - CELINE) on air quality monitoring within the EU-funded
Corona EU and VAQUUMS projects.

More details about this can be found at `Supporting the Flanders Environment
Agency (VMM) by analyzing and visualizing air quality sensor data with
InfluxDB and Grafana`_.

Adapter
=======
Implemented by `luftdatenpumpe.source.irceline <https://github.com/earthobservations/luftdatenpumpe/blob/main/luftdatenpumpe/source/irceline.py>`_

Dashboards
==========
- `Luftdaten-Viewer » IRCELINE » Map <https://vmm.panodata.net/grafana/d/CM5mTOZWk/luftdaten-viewer-irceline-map>`_
- `Luftdaten-Viewer » IRCELINE » Trend <https://vmm.panodata.net/grafana/d/JzSioOWWz/luftdaten-viewer-irceline-trend>`_

Screenshots
===========

.. figure:: https://community.panodata.org/uploads/default/original/1X/0c6f30f17d9c6c87d6b65f8daf37c6a443bffd91.png
:target: https://community.panodata.org/t/data-crunching-and-visualization/108
:alt: Comparing air quality sensors.

Comparing air quality sensors.

.. figure:: https://community.panodata.org/uploads/default/original/1X/3fc53c44ad36c08b07b2c5352cb8b3d99d997877.png
:target: https://community.panodata.org/t/data-crunching-and-visualization/108
:alt: Comparing air quality sensors.

Comparing air quality sensors.

.. figure:: https://community.panodata.org/uploads/default/original/1X/06814f55316d7e008af208bd20382d440819246c.png
:target: https://community.panodata.org/t/supporting-the-flanders-environment-agency-vmm-by-analyzing-and-visualizing-air-quality-sensor-data-with-influxdb-and-grafana/17
:alt: Humidity compensation for air quality sensors.

Humidity compensation for air quality sensors.


References
==========
- http://www.irceline.be/en
- https://www.irceline.be/en
- https://web.archive.org/web/20211129062716/http://deus.irceline.be/
- https://en.vmm.be/
- https://web.archive.org/web/20210112053937/https://project-corona.eu/default.aspx
- http://geo.irceline.be/sos/static/doc/api-doc/
- https://geo.irceline.be/sos/static/doc/api-doc/


.. _Supporting the Flanders Environment Agency (VMM) by analyzing and visualizing air quality sensor data with InfluxDB and Grafana: https://community.panodata.org/t/supporting-the-flanders-environment-agency-vmm-by-analyzing-and-visualizing-air-quality-sensor-data-with-influxdb-and-grafana/17
27 changes: 26 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,34 @@ About

Acquire and process live and historical air quality data without efforts.

Description
===========

Filter by station-id, sensor-id and sensor-type, apply reverse geocoding,
store into time-series_ and RDBMS_ databases (InfluxDB_ and PostGIS_),
publish to MQTT_, output as JSON, or visualize in `Grafana`_.

Data sources: `Sensor.Community`_ (`luftdaten.info`_), `IRCELINE`_, and
`OpenAQ`_.

The :doc:`Luftdatenpumpe README <README>` has more details about features,
screenshots, and basic usage information.

Example
=======

Visualization of `particulate matter pollution on New Year's Eve 2018`_,
as seen through measurement data of the LDI network. More information at
`Animation of fine dust pollution on New Year's Eve 2018 across Europe`_.

.. figure:: https://ptrace.hiveeyes.org/2019-02-03_particulates-on-new-year-s-eve.gif
:target: https://ptrace.hiveeyes.org/2019-02-03_particulates-on-new-year-s-eve.mp4
:alt: Fine dust pollution on New Year's Eve 2018.
:align: left

Particulate matter pollution on New Year's Eve 2018 in Europe/Germany.

|clearfix|


********
Handbook
Expand Down Expand Up @@ -71,13 +89,20 @@ Research
research/tech-radar


.. _Animation of fine dust pollution on New Year's Eve 2018 across Europe: https://community.hiveeyes.org/t/animation-der-feinstaubbelastung-an-silvester-2018-mit-grafanimate/1472
.. _Grafana: https://github.com/grafana/grafana
.. _grafanimate: https://github.com/panodata/grafanimate
.. _InfluxDB: https://github.com/influxdata/influxdb
.. _IRCELINE: https://www.irceline.be/en/documentation/open-data
.. _luftdaten.info: https://web.archive.org/web/20220604103954/https://luftdaten.info/
.. _MQTT: https://mqtt.org/
.. _OpenAQ: https://openaq.org/
.. _particulate matter pollution on New Year's Eve 2018: https://github.com/panodata/grafanimate#fine-dust-pollution-on-new-years-eve
.. _PostGIS: https://postgis.net/
.. _RDBMS: https://en.wikipedia.org/wiki/Relational_database_management_system
.. _sensor.community: https://sensor.community/en/
.. _time-series: https://en.wikipedia.org/wiki/Time_series_database

.. |clearfix| raw:: html

<div style="clear: both;"></div>

0 comments on commit 11a68c4

Please sign in to comment.