52north/sos repository overview

⁠52°North Sensor Observation Service (SOS)

Master	Develop	OpenHUB	LGTM Alerts	LGTM code quality	dependabot

⁠Description

⁠Standardized, web-based upload and download of sensor data and sensor metadata

The 52°North Sensor Observation Service (SOS) provides an interoperable web-based interface for inserting and querying sensor data and sensor descriptions. It aggregates observations from live in-situ sensors as well as historical data sets (time series data).

The 52°North SOS is a reference implementation of the OGC Sensor Observation Service specification (version 2.0)⁠, an interoperable interface for publishing and querying sensor data and metadata. It was implemented during the OGC Web Services Testbed, Phase 9 (OWS-9)⁠ and tested to be compliant to this specification within the OGC CITE testing⁠ in December of 2012.

The 52°North SOS enables the user to:

• insert and retrieve georeferenced observation data
• access georeferenced measurement data in a standardized format (ISO/OGC Observation and Measurement - O&M 2.0, OGC WaterML 2.0)
• insert and retrieve sensor descriptions (encoded according to the OGC SensorML standard - SML 1.0.1, SML 2.0)
• publish measurement data (near real-time, as well as archived data)

An extension accommodates additional INSPIRE Directive requirements, thus ensuring interoperable exchange of any kind of observation data across political, administrative and organizational boundaries. Client applications, such as Helgoland⁠ enable analysis and visualization of the measurement data provided via the SOS server.

⁠Features

• INSPIRE Download Service⁠ for measurement data
• Guidelines for the use of Observations & Measurements and Sensor Web Enablement-related standards in INSPIRE (D2.9)⁠
• [OGC Hydro Profile] (http://docs.opengeospatial.org/bp/14-004r1/14-004r1.html⁠), including GetDataAvailability operation
• SensorML 1.0.1 and 2.0⁠
• WaterML 2.0⁠
• AQD e-Reporting flows E⁠
• Multiple DB support (by using the Hibernate ORM framework⁠)
• Bundle including Sensor Web Server Helgoland⁠ and helgoland⁠
• DeleteObservation operation, to delete observation by identifier (not part of the SOS 2.0 specification)
• Efficient XML Interchange (EXI) 1.0 format⁠
• Support for GoundWaterML 2 GeologyLog observation⁠

⁠Future work

As of version 5.x, the 52N SOS's database model and DAO layer will be merged with the 52N Sensor Web Server Helgoland⁠ to provide an easy-to-install and easy-to-configure service. This service will provide an OGC SOS 2.0 interface and 52N Sensor WEB REST-API to easily access the observed data via a restful interface.

The database models of both services will be harmonized. A simple basic database model will provide the main features of the SOS and the Sensor WEB REST-API and will be easily extendable.

The Data Access Objects (DAO) layer will also be harmonized to provide a single point for accessing and manipulating the data in the database. This will reduce the maintenance and the SOS and the REST interface will easily support new database features.

In the Sensor Web Server database model⁠ the harmonized database model and the DAO layer will be provided as a separate project for use in the future 52N SOS and 52N Sensor WEB REST-API implementations. Additionally the 52N Sensor Web Server Helgoland Adapters⁠ will also use this project to persist the metadata of the harvested SOS services.

⁠Quick Start

Getting started - the installation guide⁠ helps you install and configure the 52°North SOS.

⁠Docker

Docker images are automatically deployed to Docker Hub⁠.

The configuration is located in /etc/sos. The directory is per default a volume and when no other directory is mounted (see also the Docker documentation⁠ for pre-populated volumes) a default configuration using H2 is used. This default installation uses the admin credentials admin:password. If you want to install the SOS, you have to mount a empty directory instead of the default volume.

The cache file is located in /var/lib/jetty/webapps/ROOT/tmp. The directory is per default a volume.

A custom Helgoland⁠ settings.json can be mounted to /var/lib/jetty/webapps/ROOT/static/client/helgoland/settings.json. This is needed, e.g when the external URL of the SOS differs from http://localhost:8080/.

⁠Examples

Default:

docker run -p 8080:8080 52north/sos:latest

With a local configuration folder:

docker run -p 8080:8080 -v ./config:/etc/sos 52north/sos:latest

Remote debugging enabled:

docker run -p 8080:8080 -p 8000:8000 -e 'JAVA_OPTIONS=-Xdebug -agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n' 52north/sos:latest

⁠User Guide

An Open Geospatial Consortium (OGC) SOS tutorial⁠ is currently not available, see http://www.ogcnetwork.net⁠.

⁠Demo

Access a basic form-based test client and the administrative backend at our demo site⁠.

⁠License

The 52°North SOS is published under the GNU General Public License, Version 2 (GPLv2)⁠

⁠Changelog

The latest changes, additions, bugfixes, etc. can be found in the RELEASE-NOTES⁠

⁠References

• IRCEL-CELINE⁠ (Belgium): Current and archived air quality data for all of Belgium
• Wupperverband⁠ (Germnay): Regional water board providing a multitude of hydrological measurment data with the help of SOS standards
• Swedish EPA⁠/IVL⁠/SMHI⁠ (Schweden): Current and archived air quality data for all of Sweden, as well as delivery this data to the European Protection Agency
• RIVM⁠ (Netherlands): Current and archived air quality data for all of the Netherlands
• Lithuanian EPA⁠ (Lithuania): Current and archived air quality data for all of Lithuania
• European Environment Agency (EEA)⁠: Use of SOS interface to collect data from the member countries, as well as to publish the collective data
• PEGELONLINE⁠ (Germany): Interoperable publication of te federal waterways' hydrological measurment data.

⁠Credits

⁠Contributors

The development the 52°North Sensor Observation Service implementations was contributed by

⁠Contributing organizations

The development the 52°North Sensor Observation Service implementations was contributed by several organizations

	Your logo?! Get involved!⁠

⁠Funding organizations/projects

The development the 52°North Sensor Observation Service implementations was supported by several organizations and projects. Among other we would like to thank the following organisations and project

Project/Logo	Description
	The development of this version of the 52°North SOS was supported by the European Union’s Horizon 2020⁠ research project Cos4Cloud⁠ (co-funded by the European Commission under the grant agreement n°863463)
	The development of this version of the 52°North SOS was supported by the German Federal Ministry of Education and Research⁠ research project TaMIS⁠ (co-funded by the German Federal Ministry of Education and Research, programme Geotechnologien, under grant agreement no. 03G0854[A-D])
	The development of this version of the 52°North SOS was supported by the European Union’s Horizon 2020⁠ research project JERICO-S3⁠ (co-funded by the European Commission under the grant agreement n°871153)
	The development of this version of the 52°North SOS was supported by the European FP7⁠ research project NeXOS⁠ (co-funded by the European Commission under the grant agreement n°614102)
	The development of this version of the 52°North SOS was supported by the German Federal Ministry of Education and Research⁠ research project COLABIS⁠ (co-funded by the German Federal Ministry of Education and Research, programme Geotechnologien, under grant agreement no. 03G0852A)
	The development of this version of the 52°North SOS was supported by the German Federal Ministry of of Transport and Digital Infrastructure⁠ research project WaCoDis⁠ (co-funded by the German Federal Ministry of Transport and Digital Infrastructure, programme mFund)
	The development of this version of the 52°North SOS was supported by the German Federal Ministry of Education and Research⁠ research project MuDak-WRM⁠ (co-funded by the German Federal Ministry of Education and Research, programme FONA)
	The development of this version of the 52°North SOS was supported by the Horizon 2020⁠ research project SeaDataCloud⁠ (co-funded by the European Commission under the grant agreement n°730960)
	The development of this version of the 52°North SOS was supported by the Horizon 2020⁠ research project ODIP II⁠ (co-funded by the European Commission under the grant agreement n°654310)
	The enhancements to make the 52°North SOS an INSPIRE⁠ compliant Download Service were funded by the JRC⁠ under the ISA⁠ Programme's Action 1.17: A Reusable INSPIRE Reference Platform (ARE3NA⁠).
	The IOOS⁠ project with the mission: Lead the integration of ocean, coastal, and Great Lakes observing capabilities, in collaboration with Federal and non-Federal partners, to maximize access to data and generation of information products, inform decision making, and promote economic, environmental, and social benefits to our Nation and the world.
	BRGM⁠, the French geological survey, is France's reference public institution for Earth Science applications in the management of surface and subsurface resources and risks.
	The Wupperverband⁠ for water, humans and the environment (Germany)
	The Belgian Interregional Environment Agency (IRCEL - CELINE)⁠ is active in the domain of air quality (modelling, forecasts, informing the public on the state of their air quality, e-reporting to the EU under the air quality directives, participating in scientific research on air quality, etc.). IRCEL — CELINE is a permanent cooperation between three regional environment agencies: Agence wallonne de l'Air et du Climat (AWAC)⁠, Bruxelles Environnement - Leefmilieu Brussel⁠ and Vlaamse Milieumaatschappij (VMM)⁠.
	The IVL Swedish Environmental Research Institute⁠ is an independent, non-profit research institute, owned by a foundation jointly established by the Swedish Government and Swedish industry.
	The ITZBund⁠ Information Technology Services Centre of the Federal Government (Germany)
	The German Aerospace Centre⁠ (Deutsches Zentrum fuer Luft- und Raumfahrt, DLR) and part of their <a target="_blank" href="http://www.dlr.de/eoc/en/desktopdefault.aspx/tabid-5400/10196_rea⁠