nightly docs update

gwpy · Jan 5, 2024 · 333eac4 · 333eac4
1 parent ef3bd23
commit 333eac4
Show file tree

Hide file tree

Showing 22 changed files with 20 additions and 20 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/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/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/citing/index.html b/docs/latest/citing/index.html
@@ -1026,8 +1026,8 @@ <h1 id="citing-gwpy">Citing GWpy<a class="headerlink" href="#citing-gwpy" title=
 publication, please acknowledge this by citing the
 <a class="reference external" href="https://www.sciencedirect.com/science/article/pii/S2352711021000029">GWpy paper</a>: D. M. Macleod <em>et al</em>, SoftwareX, <strong>13</strong>, 100657 (2021). The citation in various formats is given below:</p>
 <div class="tabbed-set docutils">
-<input checked="checked" id="ca580129-5056-4a29-ad75-340cd0a37019" name="1ee564d6-90e4-4ea0-89db-69776cf51708" type="radio">
-</input><label class="tabbed-label" for="ca580129-5056-4a29-ad75-340cd0a37019">
+<input checked="checked" id="92f1fd80-3f0a-4b10-9d65-cf23ed6193c7" name="3110f7d7-90ee-413d-8f41-8b083b644e81" type="radio">
+</input><label class="tabbed-label" for="92f1fd80-3f0a-4b10-9d65-cf23ed6193c7">
 BibTeX</label><div class="tabbed-content docutils">
 <div class="highlight-bibtex notranslate"><div class="highlight"><pre><span></span><code><span class="nc">@article</span><span class="p">{</span><span class="nl">gwpy</span><span class="p">,</span>
 <span class="w">    </span><span class="na">title</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">&quot;{GWpy: A Python package for gravitational-wave astrophysics}&quot;</span><span class="p">,</span>
@@ -1043,8 +1043,8 @@ <h1 id="citing-gwpy">Citing GWpy<a class="headerlink" href="#citing-gwpy" title=
 </code></pre></div>
 </div>
 </div>
-<input id="f161a385-d061-4004-9c07-d0d4b4587722" name="1ee564d6-90e4-4ea0-89db-69776cf51708" type="radio">
-</input><label class="tabbed-label" for="f161a385-d061-4004-9c07-d0d4b4587722">
+<input id="b5271ca9-fc78-4705-ac09-e20dfc70a40a" name="3110f7d7-90ee-413d-8f41-8b083b644e81" type="radio">
+</input><label class="tabbed-label" for="b5271ca9-fc78-4705-ac09-e20dfc70a40a">
 RIS</label><div class="tabbed-content docutils">
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><code><span class="n">TY</span>  <span class="o">-</span> <span class="n">JOUR</span>
 <span class="n">T1</span>  <span class="o">-</span> <span class="n">GWpy</span><span class="p">:</span> <span class="n">A</span> <span class="n">Python</span> <span class="n">package</span> <span class="k">for</span> <span class="n">gravitational</span><span class="o">-</span><span class="n">wave</span> <span class="n">astrophysics</span>
@@ -1065,8 +1065,8 @@ <h1 id="citing-gwpy">Citing GWpy<a class="headerlink" href="#citing-gwpy" title=
 </code></pre></div>
 </div>
 </div>
-<input id="a1ed1977-1fe0-4607-b1c8-e94c302aa9aa" name="1ee564d6-90e4-4ea0-89db-69776cf51708" type="radio">
-</input><label class="tabbed-label" for="a1ed1977-1fe0-4607-b1c8-e94c302aa9aa">
+<input id="351646bb-8fef-49a4-8e33-c88343d105c2" name="3110f7d7-90ee-413d-8f41-8b083b644e81" type="radio">
+</input><label class="tabbed-label" for="351646bb-8fef-49a4-8e33-c88343d105c2">
 EndNode</label><div class="tabbed-content docutils">
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><code><span class="o">%</span><span class="mi">0</span> <span class="n">Journal</span> <span class="n">Article</span>
 <span class="o">%</span><span class="n">T</span> <span class="n">GWpy</span><span class="p">:</span> <span class="n">A</span> <span class="n">Python</span> <span class="n">package</span> <span class="k">for</span> <span class="n">gravitational</span><span class="o">-</span><span class="n">wave</span> <span class="n">astrophysics</span>
@@ -1084,8 +1084,8 @@ <h1 id="citing-gwpy">Citing GWpy<a class="headerlink" href="#citing-gwpy" title=
 </code></pre></div>
 </div>
 </div>
-<input id="e761bf49-d273-4beb-8bb9-52d6310b519a" name="1ee564d6-90e4-4ea0-89db-69776cf51708" type="radio">
-</input><label class="tabbed-label" for="e761bf49-d273-4beb-8bb9-52d6310b519a">
+<input id="82a78cd2-b8b2-4ad1-8ac0-f86666bba50e" name="3110f7d7-90ee-413d-8f41-8b083b644e81" type="radio">
+</input><label class="tabbed-label" for="82a78cd2-b8b2-4ad1-8ac0-f86666bba50e">
 RefWorks</label><div class="tabbed-content docutils">
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><code><span class="n">RT</span> <span class="n">Journal</span>
 <span class="n">T1</span> <span class="n">GWpy</span><span class="p">:</span> <span class="n">A</span> <span class="n">Python</span> <span class="n">package</span> <span class="k">for</span> <span class="n">gravitational</span><span class="o">-</span><span class="n">wave</span> <span class="n">astrophysics</span>

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/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/searchindex.js b/docs/latest/searchindex.js
diff --git a/docs/latest/table/io/index.html b/docs/latest/table/io/index.html
@@ -1294,7 +1294,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 Jan 03, 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 Jan 05, 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>
@@ -1346,7 +1346,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 Jan 03, 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 Jan 05, 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>
@@ -1370,7 +1370,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 Jan 03, 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 Jan 05, 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>

diff --git a/docs/latest/timeseries/datafind/index.html b/docs/latest/timeseries/datafind/index.html
@@ -919,8 +919,8 @@ <h2 id="proprietary-datasets"><span id="gwpy-timeseries-datafind-datasets"></spa
 <p>The following table is an incomplete, but probably OK, reference to which
 dataset (<code class="docutils literal notranslate"><span class="pre">frametype</span></code>) you want to use for file-based data access:</p>
 <div class="tabbed-set docutils">
-<input checked="checked" id="e19065bc-8c00-4030-bf69-84021022a1a2" name="f25dd4ea-190b-475a-a7cf-c85c461825df" type="radio">
-</input><label class="tabbed-label" for="e19065bc-8c00-4030-bf69-84021022a1a2">
+<input checked="checked" id="7c3ff0bc-63e5-4572-b038-56d06a154ff2" name="fcd5641c-59be-437f-abc8-6e43929d3529" type="radio">
+</input><label class="tabbed-label" for="7c3ff0bc-63e5-4572-b038-56d06a154ff2">
 GEO-600</label><div class="tabbed-content docutils">
 <table class="docutils data align-default" id="gwdatafind-datasets-geo600">
 <caption><span class="caption-text">GEO-600 datasets available with <a class="reference external" href="https://gwdatafind.readthedocs.io"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gwdatafind</span></code></a></span><a class="headerlink" href="#gwdatafind-datasets-geo600" title="Permalink to this table">¶</a></caption>
@@ -940,8 +940,8 @@ <h2 id="proprietary-datasets"><span id="gwpy-timeseries-datafind-datasets"></spa
 </tbody>
 </table>
 </div>
-<input id="ec8e5116-7c26-4bd3-a40a-d1a57fb27529" name="f25dd4ea-190b-475a-a7cf-c85c461825df" type="radio">
-</input><label class="tabbed-label" for="ec8e5116-7c26-4bd3-a40a-d1a57fb27529">
+<input id="18457784-ce19-4bdd-8c21-063540068181" name="fcd5641c-59be-437f-abc8-6e43929d3529" type="radio">
+</input><label class="tabbed-label" for="18457784-ce19-4bdd-8c21-063540068181">
 LIGO-Hanford</label><div class="tabbed-content docutils">
 <table class="docutils data align-default" id="gwdatafind-datasets-ligo-hanford">
 <caption><span class="caption-text">LIGO-Hanford datasets available with <a class="reference external" href="https://gwdatafind.readthedocs.io"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gwdatafind</span></code></a></span><a class="headerlink" href="#gwdatafind-datasets-ligo-hanford" title="Permalink to this table">¶</a></caption>
@@ -986,8 +986,8 @@ <h2 id="proprietary-datasets"><span id="gwpy-timeseries-datafind-datasets"></spa
 </tbody>
 </table>
 </div>
-<input id="b54901fc-a92c-40f1-be5f-fb95d9620486" name="f25dd4ea-190b-475a-a7cf-c85c461825df" type="radio">
-</input><label class="tabbed-label" for="b54901fc-a92c-40f1-be5f-fb95d9620486">
+<input id="34fbbdb8-b1d4-4179-9b72-cb7895257324" name="fcd5641c-59be-437f-abc8-6e43929d3529" type="radio">
+</input><label class="tabbed-label" for="34fbbdb8-b1d4-4179-9b72-cb7895257324">
 LIGO-Livingston</label><div class="tabbed-content docutils">
 <table class="docutils data align-default" id="gwdatafind-datasets-ligo-livingston">
 <caption><span class="caption-text">LIGO-Livingston datasets available with <a class="reference external" href="https://gwdatafind.readthedocs.io"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gwdatafind</span></code></a></span><a class="headerlink" href="#gwdatafind-datasets-ligo-livingston" title="Permalink to this table">¶</a></caption>
@@ -1032,8 +1032,8 @@ <h2 id="proprietary-datasets"><span id="gwpy-timeseries-datafind-datasets"></spa
 </tbody>
 </table>
 </div>
-<input id="c9d40c00-7528-4ab7-bd88-9d970c6afdbc" name="f25dd4ea-190b-475a-a7cf-c85c461825df" type="radio">
-</input><label class="tabbed-label" for="c9d40c00-7528-4ab7-bd88-9d970c6afdbc">
+<input id="06c3315c-f9be-4995-b180-4d02469df3fb" name="fcd5641c-59be-437f-abc8-6e43929d3529" type="radio">
+</input><label class="tabbed-label" for="06c3315c-f9be-4995-b180-4d02469df3fb">
 Virgo</label><div class="tabbed-content docutils">
 <table class="docutils data align-default" id="gwdatafind-datasets-virgo">
 <caption><span class="caption-text">Virgo datasets available with <a class="reference external" href="https://gwdatafind.readthedocs.io"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gwdatafind</span></code></a></span><a class="headerlink" href="#gwdatafind-datasets-virgo" title="Permalink to this table">¶</a></caption>