updating docs

raspishake · Oct 18, 2021 · 4848750 · 4848750
1 parent 1565265
commit 4848750
Show file tree

Hide file tree

Showing 18 changed files with 159 additions and 107 deletions.
diff --git a/docs/_sources/test.rst.txt b/docs/_sources/test.rst.txt
@@ -20,23 +20,39 @@ and their initial state:
         # network
         'n_port':               ['port                        ', False],
         'n_internet':           ['internet                    ', False],
-        'n_inventory':          ['inventory fetch             ', False],
+        'n_inventory':          ['inventory (RS FDSN server)  ', False],
+
+        # core
+        'x_packetize':          ['packetizing data            ', False],
+        'x_send':               ['sending data                ', False],
+        'x_data':               ['receiving data              ', False],
+        'x_masterqueue':        ['master queue                ', False],
+        'x_processing':         ['processing data             ', False],
+        'x_ALARM':              ['ALARM message               ', False],
+        'x_RESET':              ['RESET message               ', False],
+        'x_IMGPATH':            ['IMGPATH message             ', False],
+        'x_TERM':               ['TERM message                ', False],
 
         # dependencies
         'd_pydub':              ['pydub dependencies          ', False],
         'd_matplotlib':         ['matplotlib backend          ', False],
 
-        # core
-        'c_data':               ['receiving data              ', False],
-        'c_processing':         ['processing data             ', False],
-        'c_miniseed':           ['miniSEED data exists        ', False],
+        # consumers
+        'c_plot':               ['plot                        ', False],
+        'c_write':              ['miniSEED write              ', False],
+        'c_miniseed':           ['miniSEED data               ', False],
+        'c_print':              ['print data                  ', False],
+        'c_alerton':            ['alert trigger on            ', False],
+        'c_alertoff':           ['alert trigger off           ', False],
+        'c_play':               ['play sound                  ', False],
         'c_img':                ['screenshot exists           ', False],
-        'c_tweet':              ['Telegram module             ', False],
-        'c_telegram':           ['Twitter module              ', False],
-        'c_ALARM':              ['ALARM message               ', False],
-        'c_RESET':              ['RESET message               ', False],
-        'c_IMGPATH':            ['IMGPATH message             ', False],
-        'c_TERM':               ['TERM message                ', False],
+        'c_tweet':              ['Twitter text message        ', False],
+        'c_tweetimg':           ['Twitter image message       ', False],
+        'c_telegram':           ['Telegram text message       ', False],
+        'c_telegramimg':        ['Telegram image              ', False],
+        'c_forward':            ['forwarding                  ', False],
+        'c_rsam':               ['RSAM transmission           ', False],
+        'c_custom':             ['custom code execution       ', False],
     }
 
 .. note::

diff --git a/docs/c_alert.html b/docs/c_alert.html
@@ -211,7 +211,7 @@
 <span id="rsudp-c-alert-sta-lta-alarm"></span><h1><a class="reference internal" href="#module-rsudp.c_alert" title="rsudp.c_alert"><code class="xref py py-data docutils literal notranslate"><span class="pre">rsudp.c_alert</span></code></a> (STA/LTA alarm)<a class="headerlink" href="#module-rsudp.c_alert" title="Permalink to this headline">¶</a></h1>
 <dl class="py class">
 <dt id="rsudp.c_alert.Alert">
-<em class="property">class </em><code class="sig-prename descclassname">rsudp.c_alert.</code><code class="sig-name descname">Alert</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">q</span></em>, <em class="sig-param"><span class="n">sta</span><span class="o">=</span><span class="default_value">5</span></em>, <em class="sig-param"><span class="n">lta</span><span class="o">=</span><span class="default_value">30</span></em>, <em class="sig-param"><span class="n">thresh</span><span class="o">=</span><span class="default_value">1.6</span></em>, <em class="sig-param"><span class="n">reset</span><span class="o">=</span><span class="default_value">1.55</span></em>, <em class="sig-param"><span class="n">bp</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">debug</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">cha</span><span class="o">=</span><span class="default_value">'HZ'</span></em>, <em class="sig-param"><span class="n">sound</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">deconv</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#rsudp.c_alert.Alert" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="sig-prename descclassname">rsudp.c_alert.</code><code class="sig-name descname">Alert</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">q</span></em>, <em class="sig-param"><span class="n">sta</span><span class="o">=</span><span class="default_value">5</span></em>, <em class="sig-param"><span class="n">lta</span><span class="o">=</span><span class="default_value">30</span></em>, <em class="sig-param"><span class="n">thresh</span><span class="o">=</span><span class="default_value">1.6</span></em>, <em class="sig-param"><span class="n">reset</span><span class="o">=</span><span class="default_value">1.55</span></em>, <em class="sig-param"><span class="n">bp</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">debug</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">cha</span><span class="o">=</span><span class="default_value">'HZ'</span></em>, <em class="sig-param"><span class="n">sound</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">deconv</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">testing</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#rsudp.c_alert.Alert" title="Permalink to this definition">¶</a></dt>
 <dd><p>A data consumer class that listens to a specific incoming data channel
 and calculates a recursive STA/LTA (short term average over long term 
 average). If a threshold of STA/LTA ratio is exceeded, the class
@@ -225,13 +225,13 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>sta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.9)"><em>float</em></a>) – short term average (STA) duration in seconds.</p></li>
-<li><p><strong>lta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.9)"><em>float</em></a>) – long term average (LTA) duration in seconds.</p></li>
-<li><p><strong>thresh</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.9)"><em>float</em></a>) – threshold for STA/LTA trigger.</p></li>
-<li><p><strong>bp</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>) – bandpass filter parameters. if set, should be in the format <code class="docutils literal notranslate"><span class="pre">[highpass,</span> <span class="pre">lowpass]</span></code></p></li>
-<li><p><strong>debug</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – whether or not to display max STA/LTA calculation live to the console.</p></li>
-<li><p><strong>cha</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – listening channel (defaults to [S,E]HZ)</p></li>
-<li><p><strong>q</strong> (<a class="reference external" href="https://docs.python.org/3/library/queue.html#queue.Queue" title="(in Python v3.9)"><em>queue.Queue</em></a>) – queue of data and messages sent by <a class="reference internal" href="c_consumer.html#rsudp.c_consumer.Consumer" title="rsudp.c_consumer.Consumer"><code class="xref py py-class docutils literal notranslate"><span class="pre">rsudp.c_consumer.Consumer</span></code></a></p></li>
+<li><p><strong>sta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><em>float</em></a>) – short term average (STA) duration in seconds.</p></li>
+<li><p><strong>lta</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><em>float</em></a>) – long term average (LTA) duration in seconds.</p></li>
+<li><p><strong>thresh</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><em>float</em></a>) – threshold for STA/LTA trigger.</p></li>
+<li><p><strong>bp</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>) – bandpass filter parameters. if set, should be in the format <code class="docutils literal notranslate"><span class="pre">[highpass,</span> <span class="pre">lowpass]</span></code></p></li>
+<li><p><strong>debug</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><em>bool</em></a>) – whether or not to display max STA/LTA calculation live to the console.</p></li>
+<li><p><strong>cha</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – listening channel (defaults to [S,E]HZ)</p></li>
+<li><p><strong>q</strong> (<a class="reference external" href="https://docs.python.org/3/library/queue.html#queue.Queue" title="(in Python v3.10)"><em>queue.Queue</em></a>) – queue of data and messages sent by <a class="reference internal" href="c_consumer.html#rsudp.c_consumer.Consumer" title="rsudp.c_consumer.Consumer"><code class="xref py py-class docutils literal notranslate"><span class="pre">rsudp.c_consumer.Consumer</span></code></a></p></li>
 </ul>
 </dd>
 </dl>

diff --git a/docs/c_alertsound.html b/docs/c_alertsound.html
@@ -211,7 +211,7 @@
 <span id="rsudp-c-alertsound-play-sound"></span><h1><a class="reference internal" href="#module-rsudp.c_alertsound" title="rsudp.c_alertsound"><code class="xref py py-data docutils literal notranslate"><span class="pre">rsudp.c_alertsound</span></code></a> (play sound)<a class="headerlink" href="#module-rsudp.c_alertsound" title="Permalink to this headline">¶</a></h1>
 <dl class="py class">
 <dt id="rsudp.c_alertsound.AlertSound">
-<em class="property">class </em><code class="sig-prename descclassname">rsudp.c_alertsound.</code><code class="sig-name descname">AlertSound</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sound</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">soundloc</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">q</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#rsudp.c_alertsound.AlertSound" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="sig-prename descclassname">rsudp.c_alertsound.</code><code class="sig-name descname">AlertSound</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">testing</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">soundloc</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">q</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#rsudp.c_alertsound.AlertSound" title="Permalink to this definition">¶</a></dt>
 <dd><p>A consumer class that plays an alert sound when an <code class="docutils literal notranslate"><span class="pre">ALARM</span></code> message arrives on the queue.
 <code class="docutils literal notranslate"><span class="pre">rsudp.c_alertsound.AlertSound.sound</span></code> is a <a class="reference external" href="https://github.com/jiaaro/pydub/blob/master/API.markdown#audiosegment">pydub.AudioSegment</a> object and is passed from the client.</p>
 <dl class="field-list simple">

diff --git a/docs/c_consumer.html b/docs/c_consumer.html
@@ -211,15 +211,15 @@
 <span id="rsudp-c-consumer-master-consumer"></span><h1><a class="reference internal" href="#module-rsudp.c_consumer" title="rsudp.c_consumer"><code class="xref py py-data docutils literal notranslate"><span class="pre">rsudp.c_consumer</span></code></a> (master consumer)<a class="headerlink" href="#module-rsudp.c_consumer" title="Permalink to this headline">¶</a></h1>
 <dl class="py class">
 <dt id="rsudp.c_consumer.Consumer">
-<em class="property">class </em><code class="sig-prename descclassname">rsudp.c_consumer.</code><code class="sig-name descname">Consumer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">queue</span></em>, <em class="sig-param"><span class="n">destinations</span></em><span class="sig-paren">)</span><a class="headerlink" href="#rsudp.c_consumer.Consumer" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="sig-prename descclassname">rsudp.c_consumer.</code><code class="sig-name descname">Consumer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">queue</span></em>, <em class="sig-param"><span class="n">destinations</span></em>, <em class="sig-param"><span class="n">testing</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#rsudp.c_consumer.Consumer" title="Permalink to this definition">¶</a></dt>
 <dd><p>The main consumer process. This consumer reads
 queue messages from the <a class="reference internal" href="p_producer.html#rsudp.p_producer.Producer" title="rsudp.p_producer.Producer"><code class="xref py py-class docutils literal notranslate"><span class="pre">rsudp.p_producer.Producer</span></code></a>
 and distributes those messages to each sub-consumer in <code class="docutils literal notranslate"><span class="pre">destinations</span></code>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/3/library/queue.html#queue.Queue" title="(in Python v3.9)"><em>queue.Queue</em></a>) – queue of data and messages sent by <a class="reference internal" href="p_producer.html#rsudp.p_producer.Producer" title="rsudp.p_producer.Producer"><code class="xref py py-class docutils literal notranslate"><span class="pre">rsudp.p_producer.Producer</span></code></a></p></li>
-<li><p><strong>destinations</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)"><em>list</em></a>) – list of <a class="reference external" href="https://docs.python.org/3/library/queue.html#queue.Queue" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">queue.Queue</span></code></a> objects to pass data to</p></li>
+<li><p><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/3/library/queue.html#queue.Queue" title="(in Python v3.10)"><em>queue.Queue</em></a>) – queue of data and messages sent by <a class="reference internal" href="p_producer.html#rsudp.p_producer.Producer" title="rsudp.p_producer.Producer"><code class="xref py py-class docutils literal notranslate"><span class="pre">rsudp.p_producer.Producer</span></code></a></p></li>
+<li><p><strong>destinations</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><em>list</em></a>) – list of <a class="reference external" href="https://docs.python.org/3/library/queue.html#queue.Queue" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">queue.Queue</span></code></a> objects to pass data to</p></li>
 </ul>
 </dd>
 </dl>

diff --git a/docs/c_custom.html b/docs/c_custom.html
@@ -211,7 +211,7 @@
 <span id="rsudp-c-custom-run-code"></span><h1><a class="reference internal" href="#module-rsudp.c_custom" title="rsudp.c_custom"><code class="xref py py-data docutils literal notranslate"><span class="pre">rsudp.c_custom</span></code></a> (run code)<a class="headerlink" href="#module-rsudp.c_custom" title="Permalink to this headline">¶</a></h1>
 <dl class="py class">
 <dt id="rsudp.c_custom.Custom">
-<em class="property">class </em><code class="sig-prename descclassname">rsudp.c_custom.</code><code class="sig-name descname">Custom</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">q</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">codefile</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">win_ovr</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#rsudp.c_custom.Custom" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="sig-prename descclassname">rsudp.c_custom.</code><code class="sig-name descname">Custom</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">q</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">codefile</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">win_ovr</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">testing</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#rsudp.c_custom.Custom" title="Permalink to this definition">¶</a></dt>
 <dd><div class="versionadded">
 <p><span class="versionmodified added">New in version 0.4.3.</span></p>
 </div>