Skip to content

Commit

Permalink
nightly docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
gwpybot authored and duncanmmacleod committed Jan 10, 2024
1 parent 08e3bb5 commit 89a94d0
Show file tree
Hide file tree
Showing 158 changed files with 895 additions and 895 deletions.
2 changes: 1 addition & 1 deletion docs/latest/.buildinfo
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: f3ab0874b320d002705de569c3517b49
config: 4ef3bf44e17d0fe025d7a4db342dfe78
tags: d77d1c0d9ca2f4c8421862c7c5a0d620
Binary file modified docs/latest/.doctrees/api/gwpy.astro.burst_range.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.astro.inspiral_range.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.astro.inspiral_range_psd.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.segments.DataQualityDict.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.segments.DataQualityFlag.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.segments.Segment.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.segments.SegmentList.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.segments.SegmentListDict.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.spectrogram.Spectrogram.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.table.EventTable.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.timeseries.StateVector.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.timeseries.TimeSeries.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.timeseries.TimeSeriesDict.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/api/gwpy.timeseries.TimeSeriesList.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/detector/channel.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/latest/.doctrees/signal/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/table/histogram.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/table/io.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/table/rate.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/time/index.doctree
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/latest/_images/gwpy-timeseries-TimeSeries-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/latest/_images/gwpy-timeseries-TimeSeries-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/latest/_images/inject-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/latest/_images/inject-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/latest/_images/inject-51.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/latest/_images/timeseries-long-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions docs/latest/api/gwpy.astro.burst_range/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@



<title>burst_range - GWpy 3.0.1.dev324+g3850e382 documentation</title>
<title>burst_range - GWpy 3.0.1.dev332+gffffb866 documentation</title>



Expand Down Expand Up @@ -83,7 +83,7 @@

<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../" title="GWpy 3.0.1.dev324+g3850e382 documentation" class="md-header__button md-logo" aria-label="GWpy 3.0.1.dev324+g3850e382 documentation" data-md-component="logo">
<a href="../../" title="GWpy 3.0.1.dev332+gffffb866 documentation" class="md-header__button md-logo" aria-label="GWpy 3.0.1.dev332+gffffb866 documentation" data-md-component="logo">
<img src="../../_static/favicon.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
Expand All @@ -93,7 +93,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
GWpy 3.0.1.dev324+g3850e382 documentation
GWpy 3.0.1.dev332+gffffb866 documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
Expand Down Expand Up @@ -202,10 +202,10 @@

<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../" title="GWpy 3.0.1.dev324+g3850e382 documentation" class="md-nav__button md-logo" aria-label="GWpy 3.0.1.dev324+g3850e382 documentation" data-md-component="logo">
<a href="../../" title="GWpy 3.0.1.dev332+gffffb866 documentation" class="md-nav__button md-logo" aria-label="GWpy 3.0.1.dev332+gffffb866 documentation" data-md-component="logo">
<img src="../../_static/favicon.png" alt="logo">
</a>
GWpy 3.0.1.dev324+g3850e382 documentation
GWpy 3.0.1.dev332+gffffb866 documentation
</label>

<div class="md-nav__source">
Expand Down Expand Up @@ -1062,7 +1062,7 @@
<h1 id="burst-range">burst_range<a class="headerlink" href="#burst-range" title="Permalink to this headline"></a></h1>
<dl class="py function objdesc">
<dt class="sig sig-object highlight py" id="gwpy.astro.burst_range">
<span class="sig-prename descclassname"><span class="pre">gwpy.astro.</span></span><span class="sig-name descname"><span class="pre">burst_range</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">psd</span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">snr</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mi">8</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">energy</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mf">0.01</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">fmin</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mi">100</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">fmax</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mi">500</span></code></em></span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gwpy/gwpy/tree/3850e382/gwpy/astro/range.py#L479-L536"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gwpy.astro.burst_range" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">gwpy.astro.</span></span><span class="sig-name descname"><span class="pre">burst_range</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">psd</span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">snr</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mi">8</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">energy</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mf">0.01</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">fmin</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mi">100</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">fmax</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mi">500</span></code></em></span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gwpy/gwpy/tree/ffffb866/gwpy/astro/range.py#L479-L536"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gwpy.astro.burst_range" title="Permalink to this definition"></a></dt>
<dd><p>Calculate the integrated GRB-like GW burst range from a strain PSD</p>
<dl class="field-list">
<dt class="field-odd" id="gwpy.astro.burst_range-parameters">Parameters<a class="headerlink" href="#gwpy.astro.burst_range-parameters" title="Permalink to this headline"></a></dt>
Expand Down
12 changes: 6 additions & 6 deletions docs/latest/api/gwpy.astro.burst_range_spectrum/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@



<title>burst_range_spectrum - GWpy 3.0.1.dev324+g3850e382 documentation</title>
<title>burst_range_spectrum - GWpy 3.0.1.dev332+gffffb866 documentation</title>



Expand Down Expand Up @@ -83,7 +83,7 @@

<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../" title="GWpy 3.0.1.dev324+g3850e382 documentation" class="md-header__button md-logo" aria-label="GWpy 3.0.1.dev324+g3850e382 documentation" data-md-component="logo">
<a href="../../" title="GWpy 3.0.1.dev332+gffffb866 documentation" class="md-header__button md-logo" aria-label="GWpy 3.0.1.dev332+gffffb866 documentation" data-md-component="logo">
<img src="../../_static/favicon.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
Expand All @@ -93,7 +93,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
GWpy 3.0.1.dev324+g3850e382 documentation
GWpy 3.0.1.dev332+gffffb866 documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
Expand Down Expand Up @@ -202,10 +202,10 @@

<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../" title="GWpy 3.0.1.dev324+g3850e382 documentation" class="md-nav__button md-logo" aria-label="GWpy 3.0.1.dev324+g3850e382 documentation" data-md-component="logo">
<a href="../../" title="GWpy 3.0.1.dev332+gffffb866 documentation" class="md-nav__button md-logo" aria-label="GWpy 3.0.1.dev332+gffffb866 documentation" data-md-component="logo">
<img src="../../_static/favicon.png" alt="logo">
</a>
GWpy 3.0.1.dev324+g3850e382 documentation
GWpy 3.0.1.dev332+gffffb866 documentation
</label>

<div class="md-nav__source">
Expand Down Expand Up @@ -1062,7 +1062,7 @@
<h1 id="burst-range-spectrum">burst_range_spectrum<a class="headerlink" href="#burst-range-spectrum" title="Permalink to this headline"></a></h1>
<dl class="py function objdesc">
<dt class="sig sig-object highlight py" id="gwpy.astro.burst_range_spectrum">
<span class="sig-prename descclassname"><span class="pre">gwpy.astro.</span></span><span class="sig-name descname"><span class="pre">burst_range_spectrum</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">psd</span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">snr</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mi">8</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">energy</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mf">0.01</span></code></em></span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gwpy/gwpy/tree/3850e382/gwpy/astro/range.py#L446-L476"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gwpy.astro.burst_range_spectrum" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">gwpy.astro.</span></span><span class="sig-name descname"><span class="pre">burst_range_spectrum</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">psd</span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">snr</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mi">8</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">energy</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mf">0.01</span></code></em></span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gwpy/gwpy/tree/ffffb866/gwpy/astro/range.py#L446-L476"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gwpy.astro.burst_range_spectrum" title="Permalink to this definition"></a></dt>
<dd><p>Calculate the frequency-dependent GW burst range from a strain PSD</p>
<dl class="field-list">
<dt class="field-odd" id="gwpy.astro.burst_range_spectrum-parameters">Parameters<a class="headerlink" href="#gwpy.astro.burst_range_spectrum-parameters" title="Permalink to this headline"></a></dt>
Expand Down
12 changes: 6 additions & 6 deletions docs/latest/api/gwpy.astro.inspiral_range/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@



<title>inspiral_range - GWpy 3.0.1.dev324+g3850e382 documentation</title>
<title>inspiral_range - GWpy 3.0.1.dev332+gffffb866 documentation</title>



Expand Down Expand Up @@ -83,7 +83,7 @@

<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../" title="GWpy 3.0.1.dev324+g3850e382 documentation" class="md-header__button md-logo" aria-label="GWpy 3.0.1.dev324+g3850e382 documentation" data-md-component="logo">
<a href="../../" title="GWpy 3.0.1.dev332+gffffb866 documentation" class="md-header__button md-logo" aria-label="GWpy 3.0.1.dev332+gffffb866 documentation" data-md-component="logo">
<img src="../../_static/favicon.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
Expand All @@ -93,7 +93,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
GWpy 3.0.1.dev324+g3850e382 documentation
GWpy 3.0.1.dev332+gffffb866 documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
Expand Down Expand Up @@ -202,10 +202,10 @@

<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../" title="GWpy 3.0.1.dev324+g3850e382 documentation" class="md-nav__button md-logo" aria-label="GWpy 3.0.1.dev324+g3850e382 documentation" data-md-component="logo">
<a href="../../" title="GWpy 3.0.1.dev332+gffffb866 documentation" class="md-nav__button md-logo" aria-label="GWpy 3.0.1.dev332+gffffb866 documentation" data-md-component="logo">
<img src="../../_static/favicon.png" alt="logo">
</a>
GWpy 3.0.1.dev324+g3850e382 documentation
GWpy 3.0.1.dev332+gffffb866 documentation
</label>

<div class="md-nav__source">
Expand Down Expand Up @@ -1062,7 +1062,7 @@
<h1 id="inspiral-range">inspiral_range<a class="headerlink" href="#inspiral-range" title="Permalink to this headline"></a></h1>
<dl class="py function objdesc">
<dt class="sig sig-object highlight sig-wrap py" id="gwpy.astro.inspiral_range">
<span class="sig-prename descclassname"><span class="pre">gwpy.astro.</span></span><span class="sig-name descname"><span class="pre">inspiral_range</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">psd</span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">snr</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mi">8</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">mass1</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mf">1.4</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">mass2</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mf">1.4</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">fmin</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">fmax</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">horizon</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">False</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em></span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gwpy/gwpy/tree/3850e382/gwpy/astro/range.py#L348-L441"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gwpy.astro.inspiral_range" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">gwpy.astro.</span></span><span class="sig-name descname"><span class="pre">inspiral_range</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">psd</span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">snr</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mi">8</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">mass1</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mf">1.4</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">mass2</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="mf">1.4</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">fmin</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">fmax</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">horizon</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">False</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em></span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gwpy/gwpy/tree/ffffb866/gwpy/astro/range.py#L348-L441"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gwpy.astro.inspiral_range" title="Permalink to this definition"></a></dt>
<dd><p>Calculate the cosmology-corrected inspiral sensitive distance</p>
<p>This method returns the distance (in megaparsecs) to which a compact
binary inspiral with the given component masses would be detectable
Expand Down
Loading

0 comments on commit 89a94d0

Please sign in to comment.