rsudp
rsudp: A Python package for real-time seismic monitoring with Raspberry Shake instruments - Published in JOSS (2021)
Science Score: 93.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 8 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Continuous visual display, sudden motion monitoring, and historical replay of Raspberry Shake data
Basic Info
- Host: GitHub
- Owner: raspishake
- License: gpl-3.0
- Language: Python
- Default Branch: master
- Homepage: https://raspishake.github.io/rsudp/
- Size: 18.4 MB
Statistics
- Stars: 65
- Watchers: 11
- Forks: 38
- Open Issues: 5
- Releases: 13
Metadata Files
README.md
rsudp
Continuous sudden motion and visual monitoring of Raspberry Shake data
Written by Ian Nesbitt (@iannesbitt), Richard Boaz, and Justin Long (@crockpotveggies)
Maintained by Raspberry Shake, S.A. for use by the citizen science and seismology-in-schools communities.
rsudp is a tool for receiving and interacting with data casts from Raspberry Shake personal seismographs and Raspberry Boom pressure transducer instruments.
rsudp has full documentation here. We also have tutorial instructions to install, set up, and run rsudp there. Additionally, our documentation features YouTube walkthroughs, notes for contributors, a brief Developer's guide, and module documentation.
We now have a paper published in The Journal of Open Source Software! You can reference rsudp using the following citation:
Nesbitt et al., (2021). rsudp: A Python package for real-time seismic monitoring with Raspberry Shake instruments. Journal of Open Source Software, 6(68), 2565, https://doi.org/10.21105/joss.02565
rsudp contains ten main features:
1. Alert - an earthquake/sudden motion alert trigger, complete with a bandpass filter and stream deconvolution capabilities
2. AlertSound - a thread that plays a MP3 audio file in the event of the alert module signalling an alarm state
3. Plot - a live-plotting routine to display data as it arrives on the port, with an option to save plots some time after an alarm
4. Tweeter - a thread that broadcasts a Twitter message when the alert module is triggered, and optionally can tweet saved plots from the plot module
5. Telegrammer - a thread similar to the Tweeter module that sends a Telegram message when an alarm is triggered, which can also broadcast saved images
6. Writer - a simple miniSEED writer
7. Forward - forward a data cast to one or several IP/port destinations
8. RSAM - computes RSAM (Real-time Seismic AMplitude) and either prints or forwards it to an IP/port destination
9. Custom - run custom code when an ALARM message is received
10. Print - a debugging tool to output raw data to the command line
rsudp is written in Python but requires no coding knowledge to run. Simply follow the instructions to install the software, go to your Shake's web front end, configure a UDP datacast to your computer's local IP address, start the software from the command line, and watch the data roll in.
(Above) a plot of an earthquake on the four channels of a Raspberry Shake 4D (EHZ---the geophone channel, and EHE, EHN, and ENZ---the accelerometer east, north, and vertical channels).
DISCLAIMER
RSUDP source code and software is provided "as is". No guarantee of functionality, performance, or advertised intent is implicitly or explicitly provided.
This project is free-to-use and free-to-copy, located in the public domain, and is provided in the hope that it may be useful.
Raspberry Shake, S.A., may, from time to time, make updates to the code base, be these bug fixes or new features. However, the company does not formally support this software / program, nor does it place itself under any obligation to respond to bug reports or new feature requests in any prescribed time frame.
Like all public projects, end-users are encouraged to provide their own bug fixes and new features as they desire: create a new branch, followed by a merge request, to have the code reviewed and folded into the main branch.
We hope you enjoy RSUDP, playing with it, and perhaps even diving into the code to see how it can be made better!
TEAM RS
Owner
- Name: raspishake
- Login: raspishake
- Kind: organization
- Email: info@raspberryshake.org
- Location: Boquete, Panamá
- Website: https://raspberryshake.org
- Repositories: 8
- Profile: https://github.com/raspishake
A Maker Space for Raspberry Shake Personal Seismograph users, hobbyists and developers.
JOSS Publication
rsudp: A Python package for real-time seismic monitoring with Raspberry Shake instruments
Authors
Raspberry Shake, S.A., School of Earth and Climate Sciences, University of Maine
Raspberry Shake, S.A.
Waterbear Energy
Editor
Jed Brown
Tags
seismology monitoring earthquake alerts Raspberry ShakeGitHub Events
Total
- Create event: 12
- Release event: 4
- Issues event: 13
- Watch event: 10
- Issue comment event: 35
- Push event: 46
- Pull request event: 27
- Fork event: 6
Last Year
- Create event: 12
- Release event: 4
- Issues event: 13
- Watch event: 10
- Issue comment event: 35
- Push event: 46
- Pull request event: 27
- Fork event: 6
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Ian Nesbitt | i****t@g****m | 837 |
| Giuseppe Petricca | 5****a | 28 |
| dmitryint | 9****t | 7 |
| Justin Long | j****g@o****m | 4 |
| raspishake | r****e@g****m | 3 |
| Richard Boaz | i****z@g****m | 2 |
| Vu | t****0@g****m | 1 |
| Navneet Srivastava | n****e@g****m | 1 |
| Jed Brown | j****d@j****g | 1 |
| Cappy | c****d@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 48
- Total pull requests: 49
- Average time to close issues: 9 months
- Average time to close pull requests: 3 months
- Total issue authors: 25
- Total pull request authors: 16
- Average comments per issue: 3.69
- Average comments per pull request: 0.8
- Merged pull requests: 33
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 5
- Pull requests: 23
- Average time to close issues: about 1 month
- Average time to close pull requests: 18 days
- Issue authors: 3
- Pull request authors: 4
- Average comments per issue: 3.8
- Average comments per pull request: 0.74
- Merged pull requests: 17
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- iannesbitt (10)
- Lallirafn (6)
- Larusrafn (4)
- fwalter (3)
- rankinstudio (3)
- urbanspectrum (2)
- matiro99 (2)
- navneetercse (1)
- Schamschula (1)
- kipdee (1)
- testaisusing (1)
- tobidurr (1)
- rodonile (1)
- andyaz (1)
- Thorinair (1)
Pull Request Authors
- dmitryint (21)
- iannesbitt (11)
- gpetricca (5)
- rankinstudio (2)
- Abril-Barrera (2)
- jadurani (2)
- chaunceygardiner (2)
- Lallirafn (1)
- kimata (1)
- crockpotveggies (1)
- dependabot[bot] (1)
- jedbrown (1)
- navneetercse (1)
- cappyccino (1)
- trinhtuanvu (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 111 last-month
- Total dependent packages: 0
- Total dependent repositories: 2
- Total versions: 12
- Total maintainers: 1
pypi.org: rsudp
Tools for receiving and interacting with Raspberry Shake UDP data
- Homepage: https://github.com/raspishake/rsudp
- Documentation: https://rsudp.readthedocs.io/
- License: GPLv3
-
Latest release: 2.2.1
published 10 months ago
Rankings
Maintainers (1)
Dependencies
- matplotlib <3.2
- numpy *
- obspy *
- pydub *
- python-telegram-bot *
- twython *
- future
- lxml
- matplotlib 3.1.1
- numpy 1.16.4
- obspy
- pip 20.0.2
- python 3.7.4
- scipy
- sqlalchemy