nightly docs update

gwpy · Aug 22, 2024 · 2882ad1 · 2882ad1
1 parent aaf3d2c
commit 2882ad1
Show file tree

Hide file tree

Showing 30 changed files with 49 additions and 49 deletions.
diff --git a/docs/latest/.doctrees/environment.pickle b/docs/latest/.doctrees/environment.pickle
diff --git a/docs/latest/.doctrees/table/io.doctree b/docs/latest/.doctrees/table/io.doctree
diff --git a/docs/latest/_downloads/52cf4a8d541cac2240f0db9007ed856f/inject-5.png b/docs/latest/_downloads/52cf4a8d541cac2240f0db9007ed856f/inject-5.png
diff --git a/docs/latest/_downloads/69ebb33d0356b3a44bdfef0d76768415/timeseries-long-1.png b/docs/latest/_downloads/69ebb33d0356b3a44bdfef0d76768415/timeseries-long-1.png
diff --git a/docs/latest/_downloads/6c50a3496ac923b791235d7e36b75660/colorbars-1.png b/docs/latest/_downloads/6c50a3496ac923b791235d7e36b75660/colorbars-1.png
diff --git a/docs/latest/_downloads/82a78a698a8d718eb062a5d0d044e9a9/inject-4.png b/docs/latest/_downloads/82a78a698a8d718eb062a5d0d044e9a9/inject-4.png
diff --git a/docs/latest/_downloads/ae32f5d42a1fa64f485930adb8ea4f81/inject-5.png b/docs/latest/_downloads/ae32f5d42a1fa64f485930adb8ea4f81/inject-5.png
diff --git a/...st/_downloads/e5f5a60b3174d1df5a5d5efc97265608/gwpy-timeseries-TimeSeries-1.png b/...st/_downloads/e5f5a60b3174d1df5a5d5efc97265608/gwpy-timeseries-TimeSeries-1.png
diff --git a/...st/_downloads/f6b04ff22353df4fdc04c11734754de7/gwpy-timeseries-TimeSeries-6.png b/...st/_downloads/f6b04ff22353df4fdc04c11734754de7/gwpy-timeseries-TimeSeries-6.png
diff --git a/docs/latest/_images/colorbars-1.png b/docs/latest/_images/colorbars-1.png
diff --git a/docs/latest/_images/gwpy-timeseries-TimeSeries-1.png b/docs/latest/_images/gwpy-timeseries-TimeSeries-1.png
diff --git a/docs/latest/_images/gwpy-timeseries-TimeSeries-6.png b/docs/latest/_images/gwpy-timeseries-TimeSeries-6.png
diff --git a/docs/latest/_images/inject-4.png b/docs/latest/_images/inject-4.png
diff --git a/docs/latest/_images/inject-5.png b/docs/latest/_images/inject-5.png
diff --git a/docs/latest/_images/inject-51.png b/docs/latest/_images/inject-51.png
diff --git a/docs/latest/_images/timeseries-long-1.png b/docs/latest/_images/timeseries-long-1.png
diff --git a/docs/latest/api/gwpy.timeseries.TimeSeries/index.html b/docs/latest/api/gwpy.timeseries.TimeSeries/index.html
diff --git a/docs/latest/install/index.html b/docs/latest/install/index.html
@@ -1165,7 +1165,7 @@ <h2 id="requirements">Requirements<a class="headerlink" href="#requirements" tit
 <tr class="row-even"><td><p><a class="reference external" href="https://dateutil.readthedocs.io"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dateutil</span></code></a></p></td>
 <td></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference external" href="http://www.scipy.org/"><a class="reference external" href="https://docs.scipy.org/doc/scipy/index.html#module-scipy" title="(in SciPy v1.14.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy</span></code></a></a></p></td>
+<tr class="row-odd"><td><p><a class="reference external" href="http://www.scipy.org/"><a class="reference external" href="https://docs.scipy.org/doc/scipy/index.html#module-scipy" title="(in SciPy v1.14.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy</span></code></a></a></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">&gt;=1.2.0</span></code></p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference external" href="https://github.com/tqdm/tqdm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tqdm</span></code></a></p></td>

diff --git a/docs/latest/objects.inv b/docs/latest/objects.inv
diff --git a/docs/latest/plot_directive/api/gwpy-timeseries-TimeSeries-1.png b/docs/latest/plot_directive/api/gwpy-timeseries-TimeSeries-1.png
diff --git a/docs/latest/plot_directive/api/gwpy-timeseries-TimeSeries-6.png b/docs/latest/plot_directive/api/gwpy-timeseries-TimeSeries-6.png
diff --git a/docs/latest/plot_directive/cli/examples/timeseries-long-1.png b/docs/latest/plot_directive/cli/examples/timeseries-long-1.png
diff --git a/docs/latest/plot_directive/examples/frequencyseries/inject-4.png b/docs/latest/plot_directive/examples/frequencyseries/inject-4.png
diff --git a/docs/latest/plot_directive/examples/frequencyseries/inject-5.png b/docs/latest/plot_directive/examples/frequencyseries/inject-5.png
diff --git a/docs/latest/plot_directive/examples/timeseries/inject-5.png b/docs/latest/plot_directive/examples/timeseries/inject-5.png
diff --git a/docs/latest/plot_directive/plot/colorbars-1.png b/docs/latest/plot_directive/plot/colorbars-1.png
diff --git a/docs/latest/searchindex.js b/docs/latest/searchindex.js
diff --git a/docs/latest/signal/index.html b/docs/latest/signal/index.html
@@ -1234,13 +1234,13 @@
 
 <h1 id="signal-processing"><span id="gwpy-signal-processing"></span>Signal processing<a class="headerlink" href="#signal-processing" title="Link to this heading">¶</a></h1>
 <p>In a wide-array of applications, the original data recorded from a digital system must be manipulated in order to extract the greatest amount of information.
-GWpy provides a suite of functions to simplify and extend the excellent digital signal processing suite in <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/signal.html#module-scipy.signal" title="(in SciPy v1.14.0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">scipy.signal</span></code></a>.</p>
+GWpy provides a suite of functions to simplify and extend the excellent digital signal processing suite in <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/signal.html#module-scipy.signal" title="(in SciPy v1.14.1)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">scipy.signal</span></code></a>.</p>
 <h2 id="spectral-density-estimation">Spectral density estimation<a class="headerlink" href="#spectral-density-estimation" title="Link to this heading">¶</a></h2>
 <p><a class="reference external" href="https://en.wikipedia.org/wiki/Spectral_density">Spectral density estimation</a>
 is a common way of investigating the frequency-domain content of a time-domain
 signal.
 GWpy provides wrappers of power spectral density (PSD) estimation methods
-from <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/signal.html#module-scipy.signal" title="(in SciPy v1.14.0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">scipy.signal</span></code></a> to simplify calculating a
+from <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/signal.html#module-scipy.signal" title="(in SciPy v1.14.1)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">scipy.signal</span></code></a> to simplify calculating a
 <a class="reference internal" href="../api/gwpy.frequencyseries.FrequencySeries/#gwpy.frequencyseries.FrequencySeries" title="gwpy.frequencyseries.FrequencySeries (Python class) — A data array holding some metadata to represent a frequency series"><code class="xref py py-class docutils literal notranslate"><span class="pre">FrequencySeries</span></code></a> from a <a class="reference internal" href="../api/gwpy.timeseries.TimeSeries/#gwpy.timeseries.TimeSeries" title="gwpy.timeseries.TimeSeries (Python class) — A time-domain data array."><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeSeries</span></code></a>.</p>
 <p>The <code class="xref py py-mod docutils literal notranslate"><span class="pre">gwpy.signal.spectral</span></code> sub-package provides the following
 PSD estimation averaging methods:</p>
@@ -1273,7 +1273,7 @@ <h2 id="spectral-density-estimation">Spectral density estimation<a class="header
 <span class="gp">&gt;&gt;&gt; </span><span class="n">psd</span> <span class="o">=</span> <span class="n">ts</span><span class="o">.</span><span class="n">psd</span><span class="p">(</span><span class="o">...</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">&#39;median&#39;</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span>
 </code></pre></div>
 </div>
-<p>See <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.welch.html#scipy.signal.welch" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.welch()</span></code></a> for more detailed documentation on the PSD
+<p>See <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.welch.html#scipy.signal.welch" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.welch()</span></code></a> for more detailed documentation on the PSD
 estimation method used.</p>
 <h2 id="time-domain-filtering">Time-domain filtering<a class="headerlink" href="#time-domain-filtering" title="Link to this heading">¶</a></h2>
 <p>The <a class="reference internal" href="../api/gwpy.timeseries.TimeSeries/#gwpy.timeseries.TimeSeries" title="gwpy.timeseries.TimeSeries (Python class) — A time-domain data array."><code class="xref py py-obj docutils literal notranslate"><span class="pre">TimeSeries</span></code></a> object comes with a number of instance methods that should make filtering data trivial for a number of common use cases.
@@ -1386,7 +1386,7 @@ <h2 id="reference-api">Reference/API<a class="headerlink" href="#reference-api"
 <dt><strong>type</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, optional, default: <code class="docutils literal notranslate"><span class="pre">'iir'</span></code></span></dt><dd><p>the filter type, either <code class="docutils literal notranslate"><span class="pre">'iir'</span></code> or <code class="docutils literal notranslate"><span class="pre">'fir'</span></code></p>
 </dd>
 <dt><strong>**kwargs</strong></dt><dd><p>other keyword arguments are passed directly to
-<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirdesign.html#scipy.signal.iirdesign" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">iirdesign()</span></code></a> or <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.firwin.html#scipy.signal.firwin" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">firwin()</span></code></a></p>
+<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirdesign.html#scipy.signal.iirdesign" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">iirdesign()</span></code></a> or <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.firwin.html#scipy.signal.firwin" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">firwin()</span></code></a></p>
 </dd>
 </dl>
 </dd>
@@ -1439,7 +1439,7 @@ <h2 id="reference-api">Reference/API<a class="headerlink" href="#reference-api"
 <dt><strong>type</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, optional, default: <code class="docutils literal notranslate"><span class="pre">'iir'</span></code></span></dt><dd><p>the filter type, either <code class="docutils literal notranslate"><span class="pre">'iir'</span></code> or <code class="docutils literal notranslate"><span class="pre">'fir'</span></code></p>
 </dd>
 <dt><strong>**kwargs</strong></dt><dd><p>other keyword arguments are passed directly to
-<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirdesign.html#scipy.signal.iirdesign" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">iirdesign()</span></code></a> or <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.firwin.html#scipy.signal.firwin" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">firwin()</span></code></a></p>
+<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirdesign.html#scipy.signal.iirdesign" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">iirdesign()</span></code></a> or <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.firwin.html#scipy.signal.firwin" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">firwin()</span></code></a></p>
 </dd>
 </dl>
 </dd>
@@ -1492,7 +1492,7 @@ <h2 id="reference-api">Reference/API<a class="headerlink" href="#reference-api"
 <dt><strong>type</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, optional, default: <code class="docutils literal notranslate"><span class="pre">'iir'</span></code></span></dt><dd><p>the filter type, either <code class="docutils literal notranslate"><span class="pre">'iir'</span></code> or <code class="docutils literal notranslate"><span class="pre">'fir'</span></code></p>
 </dd>
 <dt><strong>**kwargs</strong></dt><dd><p>other keyword arguments are passed directly to
-<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirdesign.html#scipy.signal.iirdesign" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">iirdesign()</span></code></a> or <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.firwin.html#scipy.signal.firwin" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">firwin()</span></code></a></p>
+<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirdesign.html#scipy.signal.iirdesign" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">iirdesign()</span></code></a> or <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.firwin.html#scipy.signal.firwin" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">firwin()</span></code></a></p>
 </dd>
 </dl>
 </dd>
@@ -1541,7 +1541,7 @@ <h2 id="reference-api">Reference/API<a class="headerlink" href="#reference-api"
 </dd>
 <dt><strong>output</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, optional, default: ‘zpk’</span></dt><dd><p>output format for notch</p>
 </dd>
-<dt><strong>**kwargs</strong></dt><dd><p>other keyword arguments to pass to <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirdesign.html#scipy.signal.iirdesign" title="(in SciPy v1.14.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.signal.iirdesign</span></code></a></p>
+<dt><strong>**kwargs</strong></dt><dd><p>other keyword arguments to pass to <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirdesign.html#scipy.signal.iirdesign" title="(in SciPy v1.14.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.signal.iirdesign</span></code></a></p>
 </dd>
 </dl>
 </dd>
@@ -1556,7 +1556,7 @@ <h2 id="reference-api">Reference/API<a class="headerlink" href="#reference-api"
 <div class="seealso admonition">
 <p class="admonition-title">See also</p>
 <dl class="simple">
-<dt><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirdesign.html#scipy.signal.iirdesign" title="(in SciPy v1.14.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.signal.iirdesign</span></code></a></dt><dd><p>for details on the IIR filter design method and the output formats</p>
+<dt><a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirdesign.html#scipy.signal.iirdesign" title="(in SciPy v1.14.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.signal.iirdesign</span></code></a></dt><dd><p>for details on the IIR filter design method and the output formats</p>
 </dd>
 </dl>
 </div>

diff --git a/docs/latest/table/io/index.html b/docs/latest/table/io/index.html
@@ -1291,7 +1291,7 @@ <h3 id="simple-queries"><span id="gwpy-table-gwosc-query"></span>Simple queries<
 for all events in the catalogue:</p>
 <div class="literal-block-wrapper docutils container" id="gwpy-table-io-fetch-open-data">
 <div class="code-block-caption highlight"><span class="filename"><span class="caption-text">
-</span>Fetching the GWTC-2 catalogue using <a class="reference internal" href="../../api/gwpy.table.EventTable/#gwpy.table.EventTable.fetch_open_data" title="gwpy.table.EventTable.fetch_open_data (Python method) — Fetch events from an open-data catalogue hosted by GWOSC."><code class="xref py py-meth docutils literal notranslate"><span class="pre">EventTable.fetch_open_data()</span></code></a> (output correct as of Aug 21, 2024)<a class="headerlink" href="#gwpy-table-io-fetch-open-data" title="Permalink to this code">¶</a></span></div>
+</span>Fetching the GWTC-2 catalogue using <a class="reference internal" href="../../api/gwpy.table.EventTable/#gwpy.table.EventTable.fetch_open_data" title="gwpy.table.EventTable.fetch_open_data (Python method) — Fetch events from an open-data catalogue hosted by GWOSC."><code class="xref py py-meth docutils literal notranslate"><span class="pre">EventTable.fetch_open_data()</span></code></a> (output correct as of Aug 22, 2024)<a class="headerlink" href="#gwpy-table-io-fetch-open-data" title="Permalink to this code">¶</a></span></div>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><code><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">gwpy.table</span> <span class="kn">import</span> <span class="n">EventTable</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">events</span> <span class="o">=</span> <span class="n">EventTable</span><span class="o">.</span><span class="n">fetch_open_data</span><span class="p">(</span><span class="s2">&quot;GWTC-2&quot;</span><span class="p">)</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">events</span><span class="p">)</span>
@@ -1343,7 +1343,7 @@ <h3 id="simple-queries"><span id="gwpy-table-gwosc-query"></span>Simple queries<
 <p>The full list of available columns can be queried as follows:</p>
 <div class="literal-block-wrapper docutils container" id="gwpy-table-io-fetch-open-data-info">
 <div class="code-block-caption highlight"><span class="filename"><span class="caption-text">
-</span>Printing the columns of an <a class="reference internal" href="../../api/gwpy.table.EventTable/#gwpy.table.EventTable" title="gwpy.table.EventTable (Python class) — A container for a table of events."><code class="xref py py-obj docutils literal notranslate"><span class="pre">EventTable</span></code></a> (output correct as of Aug 21, 2024)<a class="headerlink" href="#gwpy-table-io-fetch-open-data-info" title="Permalink to this code">¶</a></span></div>
+</span>Printing the columns of an <a class="reference internal" href="../../api/gwpy.table.EventTable/#gwpy.table.EventTable" title="gwpy.table.EventTable (Python class) — A container for a table of events."><code class="xref py py-obj docutils literal notranslate"><span class="pre">EventTable</span></code></a> (output correct as of Aug 22, 2024)<a class="headerlink" href="#gwpy-table-io-fetch-open-data-info" title="Permalink to this code">¶</a></span></div>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><code><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">events</span><span class="o">.</span><span class="n">info</span><span class="p">)</span>
 <span class="go">&lt;EventTable masked=True length=39&gt;</span>
 <span class="go">              name                dtype    unit            description</span>
@@ -1367,7 +1367,7 @@ <h3 id="filtered-queries"><span id="gwpy-table-gwosc-filter"></span>Filtered que
 using the <code class="docutils literal notranslate"><span class="pre">selection</span></code> keyword:</p>
 <div class="literal-block-wrapper docutils container" id="gwpy-table-io-fetch-open-data-filtered">
 <div class="code-block-caption highlight"><span class="filename"><span class="caption-text">
-</span>Downloading a sub-set of a catalogue from GWOSC (output correct as of Aug 21, 2024)<a class="headerlink" href="#gwpy-table-io-fetch-open-data-filtered" title="Permalink to this code">¶</a></span></div>
+</span>Downloading a sub-set of a catalogue from GWOSC (output correct as of Aug 22, 2024)<a class="headerlink" href="#gwpy-table-io-fetch-open-data-filtered" title="Permalink to this code">¶</a></span></div>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><code><span class="gp">&gt;&gt;&gt; </span><span class="n">t</span> <span class="o">=</span> <span class="n">EventTable</span><span class="o">.</span><span class="n">fetch_open_data</span><span class="p">(</span>
 <span class="gp">... </span>    <span class="s2">&quot;GWTC-2&quot;</span><span class="p">,</span>
 <span class="gp">... </span>    <span class="n">selection</span><span class="o">=</span><span class="s2">&quot;mass_1_source &lt; 4&quot;</span><span class="p">,</span>