gwpy 3.0.7__tar.gz → 3.0.9__tar.gz

{gwpy-3.0.7 → gwpy-3.0.9}/.codeclimate.yml

@@ -37,4 +37,3 @@ exclude_paths:
 - "examples/*"
 - "gwpy/_version.py"
 - "**/tests/"
-- "gwpy/utils/sphinx/epydoc.py"

{gwpy-3.0.7 → gwpy-3.0.9}/.github/workflows/conda.yml

@@ -51,12 +51,12 @@ jobs:
 
     steps:
     - name: Get source code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
     - name: Cache conda packages
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       env:
         # increment to reset cache
         CACHE_NUMBER: 0
@@ -67,7 +67,7 @@ jobs:
 
     - name: Cache apt (Linux)
       if: matrix.os == 'Ubuntu'
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       env:
         # increment to reset cache
         CACHE_NUMBER: 0
@@ -148,7 +148,7 @@ jobs:
         sudo cvmfs_config probe
 
     - name: Install GWpy
-      run: python -m pip install .[dev] --no-build-isolation -vv
+      run: python -m pip install .[dev,test] --no-build-isolation -vv
 
     - name: Package list
       run: conda list --name test
@@ -167,7 +167,7 @@ jobs:
 
     - name: Upload test results
       if: always()
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: pytest-conda-${{ matrix.os }}-${{ matrix.python-version }}
         path: pytest.xml

{gwpy-3.0.7 → gwpy-3.0.9}/.github/workflows/dependencies.yml

@@ -45,7 +45,7 @@ jobs:
             extras: "test"
             pip-opts: "--upgrade-strategy=only-if-needed"
           - name: "Experimental"
-            python-version: "3.9"
+            python-version: "3.11"
             experimental: true
             extras: "test,dev"
             pip-opts: "--upgrade --upgrade-strategy=eager --pre"
@@ -54,12 +54,12 @@ jobs:
 
     steps:
     - name: Get source code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -97,14 +97,14 @@ jobs:
       run: python -m coverage report --show-missing
 
     - name: Publish coverage to Codecov
-      uses: codecov/codecov-action@v1.2.1
+      uses: codecov/codecov-action@v3
       with:
         files: coverage.xml
         flags: ${{ runner.os }},python${{ matrix.python-version }}
 
     - name: Upload test results
       if: always()
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: pytest-experimental-${{ matrix.os }}-${{ matrix.python-version }}
         path: pytest.xml

{gwpy-3.0.7 → gwpy-3.0.9}/.github/workflows/dist.yml

@@ -37,12 +37,12 @@ jobs:
 
     steps:
     - name: Get source code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: '3.x'
 
@@ -52,12 +52,12 @@ jobs:
     - name: Create distributions
       run: python -m build . --sdist --wheel --outdir .
 
-    - uses: actions/upload-artifact@v2
+    - uses: actions/upload-artifact@v3
       with:
         name: tarball
         path: gwpy-*.tar.*
 
-    - uses: actions/upload-artifact@v2
+    - uses: actions/upload-artifact@v3
       with:
         name: wheel
         path: gwpy*.whl
@@ -84,6 +84,7 @@ jobs:
           - "3.9"
           - "3.10"
           - "3.11"
+          - "3.12"
     runs-on: ${{ matrix.os }}-latest
 
     defaults:
@@ -92,12 +93,12 @@ jobs:
 
     steps:
     - name: Download ${{ matrix.artifact }}
-      uses: actions/download-artifact@v2
+      uses: actions/download-artifact@v3
       with:
         name: ${{ matrix.artifact }}
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -118,6 +119,7 @@ jobs:
             --cov gwpy \
             --cov-report=xml \
             --disable-socket \
+            --allow-hosts=127.0.0.1 \
             --junitxml=pytest.xml \
             --pyargs gwpy \
         ;
@@ -133,7 +135,7 @@ jobs:
 
     - name: Upload test results
       if: always()
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: pytest-${{ matrix.artifact }}-${{ matrix.os }}-${{ matrix.python-version }}
         path: pytest.xml

{gwpy-3.0.7 → gwpy-3.0.9}/.github/workflows/lint.yml

@@ -27,9 +27,9 @@ jobs:
     name: Flake8
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: '3.x'
     - name: Install dependencies
@@ -43,9 +43,9 @@ jobs:
     name: rstcheck
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: '3.x'
     - name: Install dependencies

gwpy-3.0.9/.github/workflows/release.yml

@@ -0,0 +1,54 @@
+# ---------------------------
+#
+# Prepare distributions of this project
+# and publish them to PyPI
+#
+# ---------------------------
+
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*.*'
+
+jobs:
+  dist:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Get source code
+      uses: actions/checkout@v4
+
+    - name: Set up Python 3
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+
+    - name: Install build requirements
+      run: python -m pip install build
+
+    - name: Create distributions
+      run: python -m build . --sdist --wheel --outdir dist/
+
+    - uses: actions/upload-artifact@v3
+      with:
+        name: dist
+        path: dist/
+
+  pypi:
+    name: Upload release to pypi
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/gwpy
+    permissions:
+      id-token: write
+    steps:
+    - name: Download tarball
+      uses: actions/download-artifact@v3
+      with:
+        name: dist
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

{gwpy-3.0.7 → gwpy-3.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gwpy
-Version: 3.0.7
+Version: 3.0.9
 Summary: A python package for gravitational-wave astrophysics
 Author-email: Duncan Macleod <duncan.macleod@ligo.org>
 License: GPL-3.0-or-later
@@ -19,12 +19,14 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering :: Astronomy
 Classifier: Topic :: Scientific/Engineering :: Physics
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: astropy>=4.3.0
+Requires-Dist: dateparser>=1.1.4
 Requires-Dist: dqsegdb2
 Requires-Dist: gwdatafind>=1.1.0
 Requires-Dist: gwosc>=0.5.3
@@ -35,19 +37,19 @@ Requires-Dist: matplotlib>=3.3.0
 Requires-Dist: numpy>=1.19
 Requires-Dist: python-dateutil
 Requires-Dist: requests
-Requires-Dist: scipy>=1.5.0
+Requires-Dist: scipy>=1.6.0
 Requires-Dist: tqdm>=4.10.0
 Provides-Extra: test
 Requires-Dist: coverage[toml]>=5.0; extra == "test"
 Requires-Dist: pytest>=3.9.1; extra == "test"
-Requires-Dist: pytest-freezegun; extra == "test"
+Requires-Dist: pytest-freezer; extra == "test"
 Requires-Dist: pytest-cov>=2.4.0; extra == "test"
 Requires-Dist: pytest-requires; extra == "test"
 Requires-Dist: pytest-socket; extra == "test"
 Requires-Dist: pytest-xdist; extra == "test"
 Requires-Dist: requests-mock; extra == "test"
 Provides-Extra: astro
-Requires-Dist: inspiral-range; extra == "astro"
+Requires-Dist: inspiral-range>=0.5.0; extra == "astro"
 Provides-Extra: docs
 Requires-Dist: numpydoc>=0.8.0; extra == "docs"
 Requires-Dist: Sphinx>=4.4.0; extra == "docs"
@@ -57,10 +59,8 @@ Requires-Dist: sphinx-panels>=0.6.0; extra == "docs"
 Requires-Dist: sphinxcontrib-programoutput; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: ciecplib; extra == "dev"
-Requires-Dist: dateparser>=1.1.2; extra == "dev"
 Requires-Dist: lalsuite; sys_platform != "win32" and extra == "dev"
 Requires-Dist: lscsoft-glue; sys_platform != "win32" and extra == "dev"
-Requires-Dist: maya; python_version < "3.11" and extra == "dev"
 Requires-Dist: psycopg2; extra == "dev"
 Requires-Dist: pycbc>=1.13.4; sys_platform != "win32" and extra == "dev"
 Requires-Dist: pymysql; extra == "dev"
@@ -69,7 +69,8 @@ Requires-Dist: python-ligo-lw>=1.7.0; sys_platform != "win32" and extra == "dev"
 Requires-Dist: sqlalchemy; extra == "dev"
 Requires-Dist: uproot>=4.1.5; extra == "dev"
 Provides-Extra: conda
-Requires-Dist: python-framel>=8.40.1; extra == "conda"
+Requires-Dist: lxml!=4.9.1; sys_platform == "win32" and extra == "conda"
+Requires-Dist: python-framel!=8.46.0,>=8.40.1; extra == "conda"
 Requires-Dist: python-ldas-tools-framecpp; sys_platform != "win32" and extra == "conda"
 Requires-Dist: python-nds2-client; extra == "conda"
 

gwpy-3.0.9/docs/citing.rst.in

@@ -0,0 +1,92 @@
+###########
+Citing GWpy
+###########
+
+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:
+
+.. 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.
+See the *Export* section on each page for formatted citations in a number
+of common styles.
+
+The list below includes only the 10 most recent releases of GWpy.
+For older versions, please
+`click here <https://zenodo.org//search?page=2&size=10&q=conceptrecid:"597016"&sort=-version&all_versions=True>`__.

{gwpy-3.0.7 → gwpy-3.0.9}/docs/cli/examples.ini

@@ -33,18 +33,16 @@
 [timeseries-simple]
 command =
 	timeseries
-	--gwosc
-	--ifo H1
+	--chan H1:GDS-CALIB_STRAIN
 	--start 1126259457
-	--suptitle 'LIGO-Hanford strain around GW150914'
+	--title 'LIGO-Hanford strain around GW150914'
 title = Simple timeseries
 description = This example shows the strain timeseries for the LIGO-Hanford detector around GW150914.
 
 [timeseries-filter]
 command =
 	timeseries
-	--gwosc
-	--ifo H1
+	--chan H1:GDS-CALIB_STRAIN
 	--start 1126259458
 	--duration 8
 	--xmin 1126259462.1
@@ -56,7 +54,7 @@ command =
 	--notch 60 120
 	--ylabel 'Strain amplitude'
 	--geometry 1200x400
-	--suptitle 'LIGO-Hanford strain (filtered) around GW150914'
+	--title 'LIGO-Hanford strain (filtered) around GW150914'
 title = Filtered timeseries
 description =
 	This example shows the strain timeseries for the LIGO-Hanford detector
@@ -83,8 +81,7 @@ description =
 [spectrum-simple]
 command =
 	spectrum
-	--gwosc
-	--ifo L1
+	--chan L1:GDS-CALIB_STRAIN
 	--start 1264316100
 	--duration 32
 title = Simple spectrum
@@ -93,11 +90,11 @@ description =
 	data from the LIGO-Livingston detector around the time of GW200129_065458
 	(see |GWTC-3l|_ for full details).
 
+
 [spectrum-times]
 command =
 	spectrum
-	--gwosc
-	--ifo H1 L1
+	--chan H1:GDS-CALIB_STRAIN L1:GDS-CALIB_STRAIN
 	--start 1126259446
 	--start 1187008866
 	--duration 32
@@ -111,13 +108,12 @@ description =
 ; GW200129_065458
 command =
 	spectrum
-	--gwosc
-	--ifo H1 L1 V1
+	--chan H1:DCS-CALIB_STRAIN_CLEAN_SUB60HZ_C01 L1:DCS-CALIB_STRAIN_CLEAN_SUB60HZ_C01 V1:Hrec_hoft_16384Hz
 	--start 1264316100
 	--duration 32
 	--xmin 10
 	--xmax 4000
-	--suptitle "GW detector sensitivity around GW200129_065458"
+	--title "GW detector sensitivity around GW200129_065458"
 title = Spectrum with three interferometers
 description =
 	This example shows the spectrum (power spectral density) of strain
@@ -127,8 +123,7 @@ description =
 [spectrum-hr]
 command =
 	spectrum
-	--gwosc
-	--ifo L1
+	--chan L1:GDS-CALIB_STRAIN
 	--start 1264315518
 	--duration 1024
 	--secpfft 64
@@ -145,8 +140,7 @@ description =
 [spectrogram]
 command =
 	spectrogram
-	--gwosc
-	--ifo H1
+	--chan H1:GDS-CALIB_STRAIN
 	--start 1264316116
 	--duration 32
 	--epoch 1264316116.4
@@ -159,8 +153,7 @@ description =
 [spectrogram-norm]
 command =
 	spectrogram
-	--gwosc
-	--ifo L1
+	--chan L1:GDS-CALIB_STRAIN
 	--start 1264315518
 	--duration 1024
 	--norm

{gwpy-3.0.7 → gwpy-3.0.9}/docs/conf.py

@@ -100,12 +100,10 @@ extensions = [
     'sphinx.ext.linkcode',
     'sphinx.ext.ifconfig',
     'sphinx_automodapi.automodapi',
-    'sphinx_panels',
     'sphinxcontrib.programoutput',
     'numpydoc',
     'matplotlib.sphinxext.plot_directive',
     #'sphinxcontrib.doxylink',  # noqa: E265
-    'gwpy.utils.sphinx.epydoc',
 ]
 
 # content management
@@ -215,16 +213,9 @@ docscrape_sphinx.IMPORT_MATPLOTLIB_RE = r'\b({})\b'.format('|'.join(parts))
 # configure inheritance diagram
 inheritance_graph_attrs = dict(rankdir='TB')
 
-# -- epydoc
+# -- doxylink
 
-# epydoc extension config for GLUE
-epydoc_mapping = {
-    'http://software.ligo.org/docs/glue/': [r'glue(\.|$)'],
-}
-
-# -- epydoc
-
-LALSUITE_DOCS = 'http://software.ligo.org/docs/lalsuite'
+LALSUITE_DOCS = 'https://lscsoft.docs.ligo.org/lalsuite'
 
 doxylink = {
     'lal': ('lal.tag', '%s/lal/' % LALSUITE_DOCS),
@@ -236,6 +227,7 @@ doxylink = {
 # Intersphinx
 intersphinx_mapping = {
     'astropy': ('https://docs.astropy.org/en/stable/', None),
+    'dateparser': ('https://dateparser.readthedocs.io/en/stable/', None),
     'dateutil': ('https://dateutil.readthedocs.io/en/stable/', None),
     'dqsegdb2': ('https://dqsegdb2.readthedocs.io/en/stable/', None),
     # 'glue': ('https://docs.ligo.org/lscsoft/glue/', None),
@@ -245,6 +237,7 @@ intersphinx_mapping = {
     'ligo.skymap': ('https://lscsoft.docs.ligo.org/ligo.skymap/', None),
     'ligo-segments': ('https://lscsoft.docs.ligo.org/ligo-segments/', None),
     'ligolw': ('https://docs.ligo.org/kipp.cannon/python-ligo-lw/', None),
+    'lscsoft-glue': ('https://lscsoft.docs.ligo.org/glue/', None),
     'matplotlib': ('https://matplotlib.org/', None),
     'numpy': ('https://numpy.org/doc/stable/', None),
     'pycbc': ('https://pycbc.org/pycbc/latest/html/', None),
@@ -253,13 +246,6 @@ intersphinx_mapping = {
     'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
 }
 
-# -- sphinx-panels
-
-panels_css_variables = {
-    "tabs-color-label-active": "#ff6e40;",
-    "tabs-size-label": ".8rem",
-}
-
 
 # -- linkcode
 

{gwpy-3.0.7 → gwpy-3.0.9}/docs/install.rst

@@ -47,6 +47,7 @@ GWpy has the following strict requirements:
    Name                Constraints
    ==================  ===========================
    |astropy|_          ``>=4.0``
+   |dateparser|_       ``>=1.1.4``
    |dqsegdb2|_
    |gwdatafind|_       ``>=1.1.0``
    |gwosc-mod|_        ``>=0.5.3``

{gwpy-3.0.7 → gwpy-3.0.9}/docs/overview.rst

@@ -10,7 +10,7 @@ This package is meant for users who don't care how the code works necessarily, b
 As a result this package is meant to be as easy-to-use as possible, coupled with extensive documentation of all functions and standard examples of how to use them sensibly.
 
 The core Python infrastructure is influenced by, and extends the functionaity of, the `Astropy <http://astropy.org>`__ package, a superb set of tools for astrophysical analysis, primarily for FITS images.
-Additionally, much of the methodology has been derived from, and augmented by, the `LIGO Algorithm Library Suite (LALSuite) <https://www.lsc-group.phys.uwm.edu/daswg/projects/lalsuite.html>`_, a large collection of primarily ``C99`` routines for analysis and manipulation of data from gravitational-wave detectors.
+Additionally, much of the methodology has been derived from, and augmented by, the `LVK Algorithm Library Suite (LALSuite) <https://doi.org/10.7935/GT1W-FZ16>`_, a large collection of primarily ``C99`` routines for analysis and manipulation of data from gravitational-wave detectors.
 These packages use the `SWIG <http://www.swig.org>` program to produce Python wrappings for all ``C`` modules, allowing the GWpy package to leverage both the completeness, and the speed, of these libraries.
 
 In the end, this package has begged, borrowed, and stolen a lot of code from other sources, but should end up packaging them together in a way that makes the whole set easier to use.

{gwpy-3.0.7 → gwpy-3.0.9}/docs/references.rst

@@ -6,6 +6,9 @@
 .. |CVMFS| replace:: CVMFS
 .. _CVMFS: https://cvmfs.readthedocs.io/
 
+.. |dateparser| replace:: `dateparser`
+.. _dateparser: https://dateparser.readthedocs.io
+
 .. |dateutil| replace:: `dateutil`
 .. _dateutil: https://dateutil.readthedocs.io
 
@@ -57,13 +60,13 @@
 .. _LDAStools.frameCPP: https://computing.docs.ligo.org/ldastools/LDAS_Tools/ldas-tools-framecpp/
 
 .. |lal| replace:: `lal`
-.. _lal: http://software.ligo.org/docs/lalsuite/lal/
+.. _lal: https://lscsoft.docs.ligo.org/lalsuite/lal/
 
 .. |lal.LIGOTimeGPS| replace:: `lal.LIGOTimeGPS`
-.. _lal.LIGOTimeGPS: http://software.ligo.org/docs/lalsuite/lal/struct_l_i_g_o_time_g_p_s.html
+.. _lal.LIGOTimeGPS: https://lscsoft.docs.ligo.org/lalsuite/lal/struct_l_i_g_o_time_g_p_s.html
 
 .. |lalframe| replace:: `lalframe`
-.. _lalframe: http://software.ligo.org/docs/lalsuite/lalframe/
+.. _lalframe: https://lscsoft.docs.ligo.org/lalsuite/lalframe/
 
 .. |MySQLdb| replace:: `MySQLdb`
 .. _MySQLdb: http://mysql-python.sourceforge.net/