This license document covers hardware and software developed by OSOP, S.A. and the Raspberry Shake data sharing services.
OSOP has a keen interest in promoting seismology to both private individuals and educational facilities. Therefore, all OSOP-made software components that fall under this license are available at no additional cost to the following:
- Private users for personal use, e.g Hobbyists / Citizen Scientists
- School teachers and University professors for educational use.
Please Note: Any individual, Institute, University or Company that intends to use a Raspberry Shake product within a government earthquake monitoring, scientific research and/ or any commercial setting (e.g., Geophysical Institutes, NSF-funded grant proposals, oil and gas or mining companies, all other companies, etc.), must purchase one license per Raspberry Shake board.
A special note for hobbyists and school teachers:
Please ensure data sharing is enabled. The more people that are connected, the better and stronger our Raspberry Shake Community. The aim being to become the largest citizen scientist earthquake detection network in the world, with YOU at the center of it!
Thank you for your support!
Please play fair and purchase your license here: https://shop.raspberryshake.org
Raspberry Shake Software Components
The Raspberry Shake comes with a number of licensed and unlicensed software components. Software components that are covered under this license are denoted by (*) in the list below:
Raspberry Shake Software Components include:
- Firmware* for Raspberry Shake board
- Software for Raspberry Pi computer. Including
- SeedLink 2.6 waveform acquisition server
- SWARM for waveform visualization and interpretation
- heli_ewII for web-based waveform visualization
- ODF-MSG-ROUTER*, CAPS plugin* and SeedLink plugin* – bridge the gap between the hardware/ firmware and either the Raspberry Shake data-sharing server or centralized SeedLink or CAPS server.
- OSOP Wave Server (OWS)* – serves real-time and archived data to SWARM
- Web-based configuration modules*
- Any other software packages/ programs and scripts included in the Raspberry Shake at /usr/local/bin/ or docker containers but not listed here*
Most licensed modules are delivered as hex/ binaries that run on the Raspberry Shake board and Raspberry Pi computer. Note that SeedLink 2.6, SWARM, and heli_ewII are open-source software packages developed by Geofon and the USGS, respectively. They are free to download and use for all parties – private, personal, hobbyist, institutional or commercial.
Note About Server-Side Software Applications
This license includes use of some web-based features such as data sharing and recent earthquake detection display. When data sharing is turned on, the data sharing happens through the ODF-MSG-ROUTER protocol via the centralized Raspberry Shake server. Server-side software elements such as the Zero Configuration Server (the server-side counter-component of the ODF-MSG-ROUTER) can be licensed separately, allowing a geophysical institute, for example, to create their own data sharing platform for Raspberry Shake. Please contact email@example.com for further details.
Raspberry Shake Hardware Components
All Raspberry Shake products are closed source. Reverse engineering of any Raspberry Shake product or their components is strictly prohibited. Integration of the Raspberry Shake hardware into a company’s other hardware products for resale is strictly prohibited. OSOP is the sole authorized producer and manufacturer of Raspberry Shake products.
Raspberry Shake Data Sharing License
When you choose to share your data with the Raspberry Shake Community Server by enabling the Data Sharing option in your Raspberry Shake’s web configuration, the data essentially enters a common license where it becomes freely available to all. As a hobbyist or teacher, we make it free for you to access, view and download data from your Raspberry Shake and our Raspberry Shake Community Server. That is to say, we pay the infrastructure and data transmission costs because a primary mission of the Raspberry Shake Project is to bring hobbyists, citizen scientists and teachers into the fold and spread love for seismology. As the community grows, and with it our costs, we reserve the right to charge for these data management services.
We will not use the data from your Raspberry Shake for any nefarious purposes, mostly just to tune the automatic earthquake detection algorithms, debug and generally improve Raspberry Shake for all users.
By choosing to share you data, you automatically accept the terms and conditions of the Raspberry Shake Data Sharing License and your hereby grant to OSOP, gempa and Gempa GeoServices, a perpetual, irrevocable, non-exclusive, worldwide, royalty-free license, with the right to sublicense, to copy, to reproduce, modify, translate, broadcast, perform, share, display, distribute, transmit, frame, republish, download, display, post, use commercially , create derivative works, in any media now existing or hereafter developed, including without limitation on websites, in audio format, and in any print media format. You hereby waive any rights of publicity and privacy with respect to the shared data and any other legal or moral rights that might preclude OSOP, gempa or Gempa GeoServices’ use of the shared data or require your permission for OSOP, gempa or Gempa GeoServices to use the shared data. You agree not to assert any claim, whether based on tort, contract, or any other legal theory, against OSOP, gempa or Gempa GeoServices or its sub licensees relating to Raspberry Shake or its sub licensees use of the shared data, and you hereby release OSOP, gempa and Gempa GeoServices and its sub licensees from any such claims.
We appreciate you sharing your data for the benefit of the Raspberry Shake Community. Please rest assured that we do everything possible to ensure your exact location is always protected. We strive to provide a rich experience for you through the Raspberry Shake Community Server and the many web, desktop and mobile applications it supports.
Data Sharing and Raspberry Shake
Definition: T minus 30 minutes and older
Discrete requests (irregular and reasonable in size*): free for hobbyists, school teachers, researchers and geophysical institutes. For commercial enterprises, access to the data archive needs to be negotiated (firstname.lastname@example.org).
Continuous data streaming at T-30: free for your Raspberry Shake; has a price otherwise.
We guarantee that the data will be available for 2-years (subject to revision/ extension).
Archived data can be visualized by anyone in Swarm. See here for details.
Archived data can be downloaded by anyone via fdsnws-dataselect. See here for details.
*To be determined. If someone is trying to pull the entire catalog from our servers, then obviously we need to make other arrangements to ensure that the platform works for all users, not just the data hungry few.
Real-time data streaming servicesOption A: CAPS (recommended)
Definition of service: Real-time data streaming from the Raspberry Shake servers via CAPS protocol.
In parallel to SeedLink (Option B, see below), we provide a plug-and-play data streaming service which may not require any local network management/ opening of firewalls. The data starts streaming immediately to a centralized server, thus eliminating the needs for local system administration personnel and making the data streaming completely transparent to you, the end user. You purchase a Raspberry Shake, plug it in, turn data sharing on and data suddenly appears in real-time. Most of the time, unless you have an overzealous system administrator, this means no dinking around with firewalls, permissions, etc.
For the hobbyist and school teachers amongst us, access to this real-time data service for their station and some surrounding stations will be open and free for educational purposes only. Managing streaming will be done using authentication. Roll out of authentication scheduled for sometime in first half of 2018. All data access will be secured (https).
For third-parties that require real-time streaming services for purposes beyond hobby-ing and education, like geophysical institutes and commercial companies that might want to use the Shakes to support their own paid monitoring efforts, the service is not free (please contact email@example.com for a quote). We are currently experimenting with charging $1/ channel streaming service/ month. So the solution is very affordable. Important: The data itself is free-of-charge, the charge applies to the streaming service itself. The price should tell you that we are looking to sustain the real-time streaming services, not get rich off the data.
Advantage over SeedLink (Option B, see below):
- This is a plug-and-play solution.
- Data is secured (https).
- This is an EEW-compatible solution as data is transmitted as soon as it is available with no arbitrary packet fulfillment requirements.
Real-time data streaming options A and B are not mutually exclusive. You can share the data with the community server at the same time that you establish your own SeedLink-to-SeedLink connection(s). As always, the DIYer is totally supported by these and other policies.Option B- SeedLink
Definition: Real-time data streaming from your Shake(s) to your central SeedLink server) via SeedLink protocol.
"Free" with a hidden cost- There is, after all, no free lunch. What you do not pay for in the SeedLink software feature, you pay for in time and expertise for maintaining a knowledgeable staff and the network.
The Raspberry Shake is just like any other seismograph on the market in that it comes with SeedLink on board. This means that anyone can buy a Raspberry Shake and configure it to stream the data directly to their home institution via SeedLink. So, if you setup your Raspberry Shake with a public IP (or NAT), you can open the firewall that protects the network that the Raspberry Shake is installed on in order to permit your main SeedLink server to call out to the Raspberry Shake and establish a SeedLink connection (recall that the SeedLink server pulls its data from the client, SeedLink clients do not push their data to the server).
Downsides compared to CAPS (Option A, see above):
- This is a DIY solution that requires real know-how and time
- Data is not secured
- Data transmission is not EEW-compatible as SeedLink itself introduces significant latencies as miniSEED packets must be filled before transmission can happen.
Real-time data streaming options A and B are not mutually exclusive. You can share the data with the community server at the same time that you establish your own SeedLink-to-SeedLink connection(s). As always, the DIYer is totally supported by these and other policies.