nightly docs update

gwpy · Jan 9, 2024 · 08e3bb5 · 08e3bb5
1 parent 677d023
commit 08e3bb5
Show file tree

Hide file tree

Showing 165 changed files with 1,080 additions and 1,427 deletions.
diff --git a/docs/latest/.buildinfo b/docs/latest/.buildinfo
@@ -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: c4cfe860bf5c50bd1788de7c9d43e7c7
+config: f3ab0874b320d002705de569c3517b49
 tags: d77d1c0d9ca2f4c8421862c7c5a0d620
diff --git a/docs/latest/.doctrees/api/gwpy.astro.burst_range.doctree b/docs/latest/.doctrees/api/gwpy.astro.burst_range.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.astro.burst_range_spectrum.doctree b/docs/latest/.doctrees/api/gwpy.astro.burst_range_spectrum.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.astro.inspiral_range.doctree b/docs/latest/.doctrees/api/gwpy.astro.inspiral_range.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.astro.inspiral_range_psd.doctree b/docs/latest/.doctrees/api/gwpy.astro.inspiral_range_psd.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.frequencyseries.FrequencySeries.doctree b/docs/latest/.doctrees/api/gwpy.frequencyseries.FrequencySeries.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.frequencyseries.SpectralVariance.doctree b/docs/latest/.doctrees/api/gwpy.frequencyseries.SpectralVariance.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.segments.DataQualityDict.doctree b/docs/latest/.doctrees/api/gwpy.segments.DataQualityDict.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.segments.DataQualityFlag.doctree b/docs/latest/.doctrees/api/gwpy.segments.DataQualityFlag.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.segments.Segment.doctree b/docs/latest/.doctrees/api/gwpy.segments.Segment.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.segments.SegmentList.doctree b/docs/latest/.doctrees/api/gwpy.segments.SegmentList.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.segments.SegmentListDict.doctree b/docs/latest/.doctrees/api/gwpy.segments.SegmentListDict.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.spectrogram.Spectrogram.doctree b/docs/latest/.doctrees/api/gwpy.spectrogram.Spectrogram.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.table.EventTable.doctree b/docs/latest/.doctrees/api/gwpy.table.EventTable.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.timeseries.StateTimeSeries.doctree b/docs/latest/.doctrees/api/gwpy.timeseries.StateTimeSeries.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.timeseries.StateVector.doctree b/docs/latest/.doctrees/api/gwpy.timeseries.StateVector.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.timeseries.StateVectorDict.doctree b/docs/latest/.doctrees/api/gwpy.timeseries.StateVectorDict.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.timeseries.TimeSeries.doctree b/docs/latest/.doctrees/api/gwpy.timeseries.TimeSeries.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.timeseries.TimeSeriesDict.doctree b/docs/latest/.doctrees/api/gwpy.timeseries.TimeSeriesDict.doctree
diff --git a/docs/latest/.doctrees/api/gwpy.timeseries.TimeSeriesList.doctree b/docs/latest/.doctrees/api/gwpy.timeseries.TimeSeriesList.doctree
diff --git a/docs/latest/.doctrees/citing.doctree b/docs/latest/.doctrees/citing.doctree
diff --git a/docs/latest/.doctrees/detector/channel.doctree b/docs/latest/.doctrees/detector/channel.doctree
diff --git a/docs/latest/.doctrees/environment.pickle b/docs/latest/.doctrees/environment.pickle
diff --git a/docs/latest/.doctrees/signal/index.doctree b/docs/latest/.doctrees/signal/index.doctree
diff --git a/docs/latest/.doctrees/table/histogram.doctree b/docs/latest/.doctrees/table/histogram.doctree
diff --git a/docs/latest/.doctrees/table/io.doctree b/docs/latest/.doctrees/table/io.doctree
diff --git a/docs/latest/.doctrees/table/rate.doctree b/docs/latest/.doctrees/table/rate.doctree
diff --git a/docs/latest/.doctrees/time/index.doctree b/docs/latest/.doctrees/time/index.doctree
diff --git a/docs/latest/.doctrees/timeseries/datafind.doctree b/docs/latest/.doctrees/timeseries/datafind.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/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/docs/latest/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css
diff --git a/docs/latest/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/docs/latest/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css
diff --git a/docs/latest/_panels_static/panels-variables.7cc0733e1ecec06834f8a270f43fc6ad.css b/docs/latest/_panels_static/panels-variables.7cc0733e1ecec06834f8a270f43fc6ad.css
diff --git a/docs/latest/_sources/citing.rst.txt b/docs/latest/_sources/citing.rst.txt
@@ -6,78 +6,81 @@ If you have used GWpy as part of a project that leads to a scientific
 publication, please acknowledge this by citing the
 `GWpy paper <https://www.sciencedirect.com/science/article/pii/S2352711021000029>`_: D. M. Macleod *et al*, SoftwareX, **13**, 100657 (2021). The citation in various formats is given below:
 
-.. tabbed:: BibTeX
-
-   .. code-block:: bibtex
-
-      @article{gwpy,
-          title = "{GWpy: A Python package for gravitational-wave astrophysics}",
-         author = {{Macleod}, D.~M. and {Areeda}, J.~S. and {Coughlin}, S.~B. and {Massinger}, T.~J. and {Urban}, A.~L.},
-        journal = {SoftwareX},
-         volume = 13,
-          pages = 100657,
-           year = 2021,
-           issn = {2352-7110},
-            doi = {10.1016/j.softx.2021.100657},
-            url = {https://www.sciencedirect.com/science/article/pii/S2352711021000029},
-      }
-
-.. tabbed:: RIS
-
-   .. code-block::
-
-      TY  - JOUR
-      T1  - GWpy: A Python package for gravitational-wave astrophysics
-      AU  - Macleod, Duncan M.
-      AU  - Areeda, Joseph S.
-      AU  - Coughlin, Scott B.
-      AU  - Massinger, Thomas J.
-      AU  - Urban, Alexander L.
-      JO  - SoftwareX
-      VL  - 13
-      SP  - 100657
-      PY  - 2021
-      DA  - 2021/01/01/
-      SN  - 2352-7110
-      DO  - 10.1016/j.softx.2021.100657
-      UR  - https://www.sciencedirect.com/science/article/pii/S2352711021000029
-      ER  - 
-
-.. tabbed:: EndNode
-
-   .. code-block::
-
-      %0 Journal Article
-      %T GWpy: A Python package for gravitational-wave astrophysics
-      %A Macleod, Duncan M.
-      %A Areeda, Joseph S.
-      %A Coughlin, Scott B.
-      %A Massinger, Thomas J.
-      %A Urban, Alexander L.
-      %J SoftwareX
-      %V 13
-      %P 100657
-      %D 2021
-      %R 10.1016/j.softx.2021.100657
-      %@ 2352-7110
-
-.. tabbed:: RefWorks
-
-   .. code-block::
-
-      RT Journal
-      T1 GWpy: A Python package for gravitational-wave astrophysics
-      A1 Macleod, Duncan M.
-      A1 Areeda, Joseph S.
-      A1 Coughlin, Scott B.
-      A1 Massinger, Thomas J.
-      A1 Urban, Alexander L.
-      JF SoftwareX
-      VO 13
-      SP 100657
-      YR 2021
-      DO DOI: 10.1016/j.softx.2021.100657
-      SN 2352-7110
+.. md-tab-set::
+    :name: gwpy_citation_examples
+
+    .. md-tab-item:: BibTeX
+
+        .. code-block:: bibtex
+
+            @article{gwpy,
+                title = "{GWpy: A Python package for gravitational-wave astrophysics}",
+               author = {{Macleod}, D.~M. and {Areeda}, J.~S. and {Coughlin}, S.~B. and {Massinger}, T.~J. and {Urban}, A.~L.},
+              journal = {SoftwareX},
+               volume = 13,
+                pages = 100657,
+                 year = 2021,
+                 issn = {2352-7110},
+                  doi = {10.1016/j.softx.2021.100657},
+                  url = {https://www.sciencedirect.com/science/article/pii/S2352711021000029},
+            }
+
+    .. md-tab-item:: RIS
+
+        .. code-block::
+
+            TY  - JOUR
+            T1  - GWpy: A Python package for gravitational-wave astrophysics
+            AU  - Macleod, Duncan M.
+            AU  - Areeda, Joseph S.
+            AU  - Coughlin, Scott B.
+            AU  - Massinger, Thomas J.
+            AU  - Urban, Alexander L.
+            JO  - SoftwareX
+            VL  - 13
+            SP  - 100657
+            PY  - 2021
+            DA  - 2021/01/01/
+            SN  - 2352-7110
+            DO  - 10.1016/j.softx.2021.100657
+            UR  - https://www.sciencedirect.com/science/article/pii/S2352711021000029
+            ER  - 
+
+    .. md-tab-item:: EndNode
+
+         .. code-block::
+
+            %0 Journal Article
+            %T GWpy: A Python package for gravitational-wave astrophysics
+            %A Macleod, Duncan M.
+            %A Areeda, Joseph S.
+            %A Coughlin, Scott B.
+            %A Massinger, Thomas J.
+            %A Urban, Alexander L.
+            %J SoftwareX
+            %V 13
+            %P 100657
+            %D 2021
+            %R 10.1016/j.softx.2021.100657
+            %@ 2352-7110
+
+    .. md-tab-item:: RefWorks
+
+        .. code-block::
+
+            RT Journal
+            T1 GWpy: A Python package for gravitational-wave astrophysics
+            A1 Macleod, Duncan M.
+            A1 Areeda, Joseph S.
+            A1 Coughlin, Scott B.
+            A1 Massinger, Thomas J.
+            A1 Urban, Alexander L.
+            JF SoftwareX
+            VO 13
+            SP 100657
+            YR 2021
+            DO DOI: 10.1016/j.softx.2021.100657
+            SN 2352-7110
 
 Also cite the DOI for the version of GWpy that you have used.
 Each of the DOIs below resolves a Zenodo record for that version.

diff --git a/docs/latest/_sources/timeseries/datafind.rst.txt b/docs/latest/_sources/timeseries/datafind.rst.txt
@@ -117,83 +117,86 @@ significantly speed up the search.
 The following table is an incomplete, but probably OK, reference to which
 dataset (``frametype``) you want to use for file-based data access:
 
-.. tabbed:: GEO-600
-
-   .. table:: GEO-600 datasets available with |gwdatafind|_
-      :name: gwdatafind-datasets-geo600
-
-      ========================  =====================================================
-      Dataset (frametype)       Description
-      ========================  =====================================================
-      ``G1_RDS_C01_L3``         The GEO-600 data, including calibrated strain *h(t)*
-      ========================  =====================================================
-
-.. tabbed:: LIGO-Hanford
-
-   .. table:: LIGO-Hanford datasets available with |gwdatafind|_
-      :name: gwdatafind-datasets-ligo-hanford
-
-      ========================  =====================================================
-      Dataset (frametype)       Description
-      ========================  =====================================================
-      ``H1_R``                  All auxiliary channels, stored at the native sampling
-                                rate
-      ``H1_T``                  Second trends of all channels, including
-                                ``.mean``, ``.min``, and ``.max``
-      ``H1_M``                  Minute trends of all channels, including
-                                ``.mean``, ``.min``, and ``.max``
-      ``H1_HOFT_C00``           Strain *h(t)* and metadata generated using the
-                                real-time calibration pipeline
-      ``H1_HOFT_CXY``           Strain *h(t)* and metadata generated using the
-                                off-line calibration pipeline at version ``XY``
-      ``H1_GWOSC_O2_4KHZ_R1``   4k Hz Strain *h(t)* and metadata as released by
-                                |GWOSC|_ for the O2 data release
-      ``H1_GWOSC_O2_16KHZ_R1``  16k Hz Strain *h(t)* and metadata as released by
-                                |GWOSC|_ for the O2 data release
-      ========================  =====================================================
-
-.. tabbed:: LIGO-Livingston
-
-   .. table:: LIGO-Livingston datasets available with |gwdatafind|_
-      :name: gwdatafind-datasets-ligo-livingston
-
-      ========================  =====================================================
-      Dataset (frametype)       Description
-      ========================  =====================================================
-      ``L1_R``                  All auxiliary channels, stored at the native sampling
-                                rate
-      ``L1_T``                  Second trends of all channels, including
-                                ``.mean``, ``.min``, and ``.max``
-      ``L1_M``                  Minute trends of all channels, including
-                                ``.mean``, ``.min``, and ``.max``
-      ``L1_HOFT_C00``           Strain *h(t)* and metadata generated using the
-                                real-time calibration pipeline
-      ``L1_HOFT_CXY``           Strain *h(t)* and metadata generated using the
-                                off-line calibration pipeline at version ``XY``
-      ``L1_GWOSC_O2_4KHZ_R1``   4k Hz Strain *h(t)* and metadata as released by
-                                |GWOSC|_ for the O2 data release
-      ``L1_GWOSC_O2_16KHZ_R1``  16k Hz Strain *h(t)* and metadata as released by
-                                |GWOSC|_ for the O2 data release
-      ========================  =====================================================
-
-.. tabbed:: Virgo
-
-   .. table:: Virgo datasets available with |gwdatafind|_
-      :name: gwdatafind-datasets-virgo
-
-      ========================  =====================================================
-      Dataset (frametype)       Description
-      ========================  =====================================================
-      ``raw``                   All auxiliary channels, stored at the native sampling
-                                rate
-      ``V1O2Repro1A``           Strain *h(t)* and metadata for Observing run 3
-                                (``O3``) generated off-line using version ``1A``
-                                calibration; replace ``O2`` and ``1A`` as appropriate
-      ``V1_GWOSC_O2_4KHZ_R1``   4k Hz Strain *h(t)* and metadata as released by
-                                |GWOSC|_ for the O2 data release
-      ``V1_GWOSC_O2_16KHZ_R1``  16k Hz Strain *h(t)* and metadata as released by
-                                |GWOSC|_ for the O2 data release
-      ========================  =====================================================
+.. md-tab-set::
+    :name: gwpy_gwdatafind_datasets
+
+    .. md-tab-item:: GEO-600
+
+        .. table:: GEO-600 datasets available with |gwdatafind|_
+            :name: gwdatafind-datasets-geo600
+
+            ========================  =====================================================
+            Dataset (frametype)       Description
+            ========================  =====================================================
+            ``G1_RDS_C01_L3``         The GEO-600 data, including calibrated strain *h(t)*
+            ========================  =====================================================
+
+    .. md-tab-item:: LIGO-Hanford
+
+        .. table:: LIGO-Hanford datasets available with |gwdatafind|_
+            :name: gwdatafind-datasets-ligo-hanford
+
+            ========================  =====================================================
+            Dataset (frametype)       Description
+            ========================  =====================================================
+            ``H1_R``                  All auxiliary channels, stored at the native sampling
+                                      rate
+            ``H1_T``                  Second trends of all channels, including
+                                      ``.mean``, ``.min``, and ``.max``
+            ``H1_M``                  Minute trends of all channels, including
+                                      ``.mean``, ``.min``, and ``.max``
+            ``H1_HOFT_C00``           Strain *h(t)* and metadata generated using the
+                                      real-time calibration pipeline
+            ``H1_HOFT_CXY``           Strain *h(t)* and metadata generated using the
+                                      off-line calibration pipeline at version ``XY``
+            ``H1_GWOSC_O2_4KHZ_R1``   4k Hz Strain *h(t)* and metadata as released by
+                                      |GWOSC|_ for the O2 data release
+            ``H1_GWOSC_O2_16KHZ_R1``  16k Hz Strain *h(t)* and metadata as released by
+                                      |GWOSC|_ for the O2 data release
+            ========================  =====================================================
+
+    .. md-tab-item:: LIGO-Livingston
+
+        .. table:: LIGO-Livingston datasets available with |gwdatafind|_
+            :name: gwdatafind-datasets-ligo-livingston
+
+            ========================  =====================================================
+            Dataset (frametype)       Description
+            ========================  =====================================================
+            ``L1_R``                  All auxiliary channels, stored at the native sampling
+                                      rate
+            ``L1_T``                  Second trends of all channels, including
+                                      ``.mean``, ``.min``, and ``.max``
+            ``L1_M``                  Minute trends of all channels, including
+                                      ``.mean``, ``.min``, and ``.max``
+            ``L1_HOFT_C00``           Strain *h(t)* and metadata generated using the
+                                      real-time calibration pipeline
+            ``L1_HOFT_CXY``           Strain *h(t)* and metadata generated using the
+                                      off-line calibration pipeline at version ``XY``
+            ``L1_GWOSC_O2_4KHZ_R1``   4k Hz Strain *h(t)* and metadata as released by
+                                      |GWOSC|_ for the O2 data release
+            ``L1_GWOSC_O2_16KHZ_R1``  16k Hz Strain *h(t)* and metadata as released by
+                                      |GWOSC|_ for the O2 data release
+            ========================  =====================================================
+
+    .. md-tab-item:: Virgo
+
+        .. table:: Virgo datasets available with |gwdatafind|_
+            :name: gwdatafind-datasets-virgo
+
+            ========================  =====================================================
+            Dataset (frametype)       Description
+            ========================  =====================================================
+            ``raw``                   All auxiliary channels, stored at the native sampling
+                                      rate
+            ``V1O2Repro1A``           Strain *h(t)* and metadata for Observing run 3
+                                      (``O3``) generated off-line using version ``1A``
+                                      calibration; replace ``O2`` and ``1A`` as appropriate
+            ``V1_GWOSC_O2_4KHZ_R1``   4k Hz Strain *h(t)* and metadata as released by
+                                      |GWOSC|_ for the O2 data release
+            ``V1_GWOSC_O2_16KHZ_R1``  16k Hz Strain *h(t)* and metadata as released by
+                                      |GWOSC|_ for the O2 data release
+            ========================  =====================================================
 
 .. admonition:: Not all datasets are available everywhere
 

diff --git a/docs/latest/_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/docs/latest/_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css