Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@dmitryint
dmitryint committed Nov 11, 2024
1 parent fc6449a commit 31084e8
Show file tree
Hide file tree
Showing 76 changed files with 5,295 additions and 5,207 deletions.
Empty file added .github/workflows/deploy_docs_from_docsrc.yaml
View file
Empty file.
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f7994a17419173945d8508a3eff5fb7e
config: 10931521fcf0ca189e6049e5e7352e60
tags: 645f666f9bcd5a90fca523b33c5a78b7
228 changes: 114 additions & 114 deletions docs/_sources/about.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,114 +1,114 @@
About rsudp
#####################################

.. |raspberryshake| raw:: html

<a href="https://raspberryshake.org" target="_blank">Raspberry Shake S.A.</a>

.. |github| raw:: html

<a href="https://github.com/raspishake/rsudp" target="_blank">here</a>

rsudp is an open source program developed for the community by |raspberryshake|
to actively monitor and plot UDP data cast output from Raspberry Shake instruments.

Broad overview
*************************************

rsudp is a collection of python monitoring and notification tools
to accompany Raspberry Shake seismographs and pressure transducers.
It contains code for continuous plotting, continuous monitoring of sudden motion,
and distribution of alert notifications via multiple media including audible sound
and the Telegram and Twitter social media platforms.

rsudp is able to run as a stable headless daemon or GUI application continuously
on most systems with sufficent RAM, and can be used to power both a display kiosk
and notification system simultaneously.

Why it's special
*************************************

rsudp's uses as an educational tool in both seismology and computer science are broad.

The demands of real-time seismic processing
require that calculations must be made quickly and
remain stable for weeks or months without user intervention.
rsudp aims to achieve both of these things,
while maintaining a codebase lean enough to run on Raspberry Pi
but intuitive enough that users can learn the theory of
real time continuous data processing and contribute code of their own.
The project's source repository is |github|.

Programs that do similar tasks are usually not as fully-featured, cost money,
are unmaintained, or are complex to set up and run.
We have tried to keep dependencies to a minimum and installation simple
across multiple platforms.

In addition, we spent many hours making rsudp's plotting routines a beautiful
and informative way to explore the vibrations that move through Earth's crust
(see 4d-event_ figure below).
Whether looking at an earthquake trace from far away or a car going by on a street,
the plots are designed to show the user the character of the vibration in an easy
to grasp yet informative format.


.. _4d-event:
.. figure:: _static/4d-event.png
:align: center

An earthquake event recorded on the accelerometer and geophone channels of a
Raspberry Shake 4D, recorded by rsudp and saved by its plotting module.


While the plotting may be the centerpiece of the program,
perhaps the most useful aspect of rsudp is its ability to monitor sudden motion
and trigger multiple outcomes and actions when events are detected.
Additionally, the way it was designed leaves room for developers
to add their own code to be run when events are detected.

rsudp is a special and unique piece of software in the seismological community
which brings easy-to-use open-source monitoring to low cost instrumentation.

What can't rsudp do?
*************************************

.. |license| raw:: html

<a href="https://github.com/raspishake/rsudp/blob/master/LICENSE" target="_blank">license</a>

.. warning::

**Standard performance disclaimer**

It is extremely important that you do not rely on this code to save life or property.
It is not a substitute for earthquake early warning (EEW), or state or local official
communication and alert systems.

Although this software can detect earthquakes and sudden motion events,
Raspberry Shake makes no guarantee and provides no warranty in any way,
implied or explicit, for the performance of this software in earthquake detection.

Raspberry Shake assumes no liability for false positives, false negatives,
errors running the Alert module, or any other part of this software;
it is meant for hobby and non-professional notification use only.

If you need professional-grade software to provide a warning intended to save life
or property, please contact Raspberry Shake directly or look elsewhere.
See sections 16 and 16b of the |license| for further details.


As noted in the |license|,
Raspberry Shake S.A. does not assume any liability or make any guarantee regarding
the performance of this software in detecting earthquakes.
Due to the unpredictable nature of earthquakes and the fact that this is not professional
monitoring software, this software should not be used to protect life or property.

Due to the limitations of the Raspberry Pi 3B's RAM modules, rsudp will run but occasionally
suffer from memory errors if the plotting module is enabled.
It can be programmed as a daemon in order to restart in the event of one of these errors,
which means that its monitoring capability may have brief periods of non-availability
on these devices (after :ref:`install`, see :ref:`daemon`).
The Raspberry Pi 4B does not seem to suffer nearly as much from this issue,
but this has not been tested extensively.

`Back to top ↑ <#top>`_
About rsudp
#####################################

.. |raspberryshake| raw:: html

<a href="https://raspberryshake.org" target="_blank">Raspberry Shake S.A.</a>

.. |github| raw:: html

<a href="https://github.com/raspishake/rsudp" target="_blank">here</a>

rsudp is an open source program developed for the community by |raspberryshake|
to actively monitor and plot UDP data cast output from Raspberry Shake instruments.

Broad overview
*************************************

rsudp is a collection of python monitoring and notification tools
to accompany Raspberry Shake seismographs and pressure transducers.
It contains code for continuous plotting, continuous monitoring of sudden motion,
and distribution of alert notifications via multiple media including audible sound
and the Telegram and Twitter social media platforms.

rsudp is able to run as a stable headless daemon or GUI application continuously
on most systems with sufficent RAM, and can be used to power both a display kiosk
and notification system simultaneously.

Why it's special
*************************************

rsudp's uses as an educational tool in both seismology and computer science are broad.

The demands of real-time seismic processing
require that calculations must be made quickly and
remain stable for weeks or months without user intervention.
rsudp aims to achieve both of these things,
while maintaining a codebase lean enough to run on Raspberry Pi
but intuitive enough that users can learn the theory of
real time continuous data processing and contribute code of their own.
The project's source repository is |github|.

Programs that do similar tasks are usually not as fully-featured, cost money,
are unmaintained, or are complex to set up and run.
We have tried to keep dependencies to a minimum and installation simple
across multiple platforms.

In addition, we spent many hours making rsudp's plotting routines a beautiful
and informative way to explore the vibrations that move through Earth's crust
(see 4d-event_ figure below).
Whether looking at an earthquake trace from far away or a car going by on a street,
the plots are designed to show the user the character of the vibration in an easy
to grasp yet informative format.


.. _4d-event:
.. figure:: _static/4d-event.png
:align: center

An earthquake event recorded on the accelerometer and geophone channels of a
Raspberry Shake 4D, recorded by rsudp and saved by its plotting module.


While the plotting may be the centerpiece of the program,
perhaps the most useful aspect of rsudp is its ability to monitor sudden motion
and trigger multiple outcomes and actions when events are detected.
Additionally, the way it was designed leaves room for developers
to add their own code to be run when events are detected.

rsudp is a special and unique piece of software in the seismological community
which brings easy-to-use open-source monitoring to low cost instrumentation.

What can't rsudp do?
*************************************

.. |license| raw:: html

<a href="https://github.com/raspishake/rsudp/blob/master/LICENSE" target="_blank">license</a>

.. warning::

**Standard performance disclaimer**

It is extremely important that you do not rely on this code to save life or property.
It is not a substitute for earthquake early warning (EEW), or state or local official
communication and alert systems.

Although this software can detect earthquakes and sudden motion events,
Raspberry Shake makes no guarantee and provides no warranty in any way,
implied or explicit, for the performance of this software in earthquake detection.

Raspberry Shake assumes no liability for false positives, false negatives,
errors running the Alert module, or any other part of this software;
it is meant for hobby and non-professional notification use only.

If you need professional-grade software to provide a warning intended to save life
or property, please contact Raspberry Shake directly or look elsewhere.
See sections 16 and 16b of the |license| for further details.


As noted in the |license|,
Raspberry Shake S.A. does not assume any liability or make any guarantee regarding
the performance of this software in detecting earthquakes.
Due to the unpredictable nature of earthquakes and the fact that this is not professional
monitoring software, this software should not be used to protect life or property.

Due to the limitations of the Raspberry Pi 3B's RAM modules, rsudp will run but occasionally
suffer from memory errors if the plotting module is enabled.
It can be programmed as a daemon in order to restart in the event of one of these errors,
which means that its monitoring capability may have brief periods of non-availability
on these devices (after :ref:`install`, see :ref:`daemon`).
The Raspberry Pi 4B does not seem to suffer nearly as much from this issue,
but this has not been tested extensively.

`Back to top ↑ <#top>`_
28 changes: 14 additions & 14 deletions docs/_sources/c_alert.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:py:data:`rsudp.c_alert` (STA/LTA alarm)
=====================================================

.. automodule:: rsudp.c_alert
:members:

................

* :ref:`genindex`
* :ref:`search`

.. * :ref:`modindex`
`Back to top ↑ <#top>`_
:py:data:`rsudp.c_alert` (STA/LTA alarm)
=====================================================

.. automodule:: rsudp.c_alert
:members:

................

* :ref:`genindex`
* :ref:`search`

.. * :ref:`modindex`
`Back to top ↑ <#top>`_
28 changes: 14 additions & 14 deletions docs/_sources/c_alertsound.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:py:data:`rsudp.c_alertsound` (play sound)
=====================================================

.. automodule:: rsudp.c_alertsound
:members:

................

* :ref:`genindex`
* :ref:`search`

.. * :ref:`modindex`
`Back to top ↑ <#top>`_
:py:data:`rsudp.c_alertsound` (play sound)
=====================================================

.. automodule:: rsudp.c_alertsound
:members:

................

* :ref:`genindex`
* :ref:`search`

.. * :ref:`modindex`
`Back to top ↑ <#top>`_
28 changes: 14 additions & 14 deletions docs/_sources/c_consumer.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:py:data:`rsudp.c_consumer` (master consumer)
=====================================================

.. automodule:: rsudp.c_consumer
:members:

................

* :ref:`genindex`
* :ref:`search`

.. * :ref:`modindex`
`Back to top ↑ <#top>`_
:py:data:`rsudp.c_consumer` (master consumer)
=====================================================

.. automodule:: rsudp.c_consumer
:members:

................

* :ref:`genindex`
* :ref:`search`

.. * :ref:`modindex`
`Back to top ↑ <#top>`_
28 changes: 14 additions & 14 deletions docs/_sources/c_custom.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:py:data:`rsudp.c_custom` (run code)
=====================================================

.. automodule:: rsudp.c_custom
:members:

................

* :ref:`genindex`
* :ref:`search`

.. * :ref:`modindex`
`Back to top ↑ <#top>`_
:py:data:`rsudp.c_custom` (run code)
=====================================================

.. automodule:: rsudp.c_custom
:members:

................

* :ref:`genindex`
* :ref:`search`

.. * :ref:`modindex`
`Back to top ↑ <#top>`_
28 changes: 14 additions & 14 deletions docs/_sources/c_forward.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:py:data:`rsudp.c_forward` (forward data)
=====================================================

.. automodule:: rsudp.c_forward
:members:

................

* :ref:`genindex`
* :ref:`search`

.. * :ref:`modindex`
`Back to top ↑ <#top>`_
:py:data:`rsudp.c_forward` (forward data)
=====================================================

.. automodule:: rsudp.c_forward
:members:

................

* :ref:`genindex`
* :ref:`search`

.. * :ref:`modindex`
`Back to top ↑ <#top>`_
Loading

0 comments on commit 31084e8

Please sign in to comment.