sxs 2023.1.5__py3-none-any.whl → 2023.1.7__py3-none-any.whl

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2023.1.5"
+__version__ = "2023.1.7"

sxs/catalog/catalog.py

@@ -6,7 +6,7 @@ import functools
 # noinspection SpellCheckingInspection
 class Catalog(object):
     """Container interface to the SXS catalog"""
-    url = "https://data.black-holes.org/catalog.json"
+    url = "https://data.black-holes.org/catalog.zip"
 
     def __init__(self, catalog=None, **kwargs):
         from .. import Metadata
@@ -54,6 +54,19 @@ class Catalog(object):
         from .. import sxs_directory, read_config
         from ..utilities import download_file
 
+        from warnings import warn
+        deprecation_notice = """
+
+        You have called a function that uses the `Catalog` class,
+        which, as of `sxs` version 2024.0.0, has been deprecated in
+        favor of the `Simulations` interface.  See the documentation
+        for more information.
+
+        THIS CAN ONLY PROVIDE OLD DATA!
+
+        """
+        warn(deprecation_notice)
+
         progress = read_config("download_progress", True)
 
         cache_path = sxs_directory("cache") / "catalog.zip"
@@ -64,36 +77,12 @@ class Catalog(object):
             if_newer = False
 
         if download or download is None:
-            # 1. Download the full json file (zipped in flight, but auto-decompressed on arrival)
-            # 2. Zip to a temporary file (using bzip2, which is better than the in-flight compression)
-            # 3. Replace the original catalog.zip with the temporary zip file
-            # 4. Remove the full json file
-            # 5. Make sure the temporary zip file is gone too
-            temp_json = cache_path.with_suffix(".temp.json")
-            temp_zip = cache_path.with_suffix(".temp.zip")
             try:
-                try:
-                    download_file(cls.url, temp_json, progress=progress, if_newer=if_newer)
-                except Exception as e:
-                    if download:
-                        raise RuntimeError(f"Failed to download '{cls.url}'; try setting `download=False`") from e
-                    download_failed = e  # We'll try the cache
-                else:
-                    download_failed = False
-                    if temp_json.exists():
-                        with zipfile.ZipFile(temp_zip, "w", compression=zipfile.ZIP_BZIP2) as catalog_zip:
-                            catalog_zip.write(temp_json, arcname="catalog.json")
-                        temp_zip.replace(cache_path)
-            finally:
-                # The `missing_ok` argument to `unlink` would be much nicer, but was added in python 3.8
-                try:
-                    temp_json.unlink()
-                except FileNotFoundError as e:
-                    pass
-                try:
-                    temp_zip.unlink()
-                except FileNotFoundError as e:
-                    pass
+                download_file(cls.url, cache_path, progress=progress, if_newer=if_newer)
+            except Exception as e:
+                if download:
+                    raise RuntimeError(f"Failed to download '{cls.url}'; try setting `download=False`") from e
+                download_failed = e  # We'll try the cache
 
         if not cache_path.exists():
             if download is False:  # Test if it literally *is* False, rather than just casts to False

sxs/julia/__init__.py

@@ -14,7 +14,11 @@ def pkg_update():
     return PostNewtonian.seval("Pkg.update()")
 
 
-def PNWaveform(M1, M2, chi1, chi2, Omega_i, **kwargs):
+def PNWaveform(
+        M1, M2, chi1, chi2, Omega_i, *,
+        ell_min=2, ell_max=8, waveform_pn_order=None,
+        **orbital_evolution_kwargs
+):
     """Generate a PN waveform.
 
     The return value is an `sxs.WaveformModes` object with the
@@ -24,7 +28,8 @@ def PNWaveform(M1, M2, chi1, chi2, Omega_i, **kwargs):
         - `M2` (array): The secondary mass as a function of time.
         - `chi1` (array): The primary spin as a function of time.
         - `chi2` (array): The secondary spin as a function of time.
-        - `frame` (array): The quaternionic frame as a function of time.
+        - `frame` (array): The quaternionic frame as a function of
+          time.
         - `v` (array): The orbital velocity as a function of time.
         - `orbital_phase` (array): The orbital phase as a function of
           time.
@@ -34,21 +39,32 @@ def PNWaveform(M1, M2, chi1, chi2, Omega_i, **kwargs):
     `PostNewtonian.inertial_waveform`.  See [the Julia
     documentation](https://moble.github.io/PostNewtonian.jl/dev/internals/dynamics/#PostNewtonian.orbital_evolution)
     for details on the optional keyword arguments.
+
+    Note that the full Julia interface is also accessible from this
+    Python module.  See [the Julia
+    docs](https://moble.github.io/PostNewtonian.jl/dev/interface/python/)
+    for details.  Also, the GWFrames submodule of this module provides
+    another interface.
     
     """
     # Integrate the orbital dynamics
-    inspiral = PostNewtonian.orbital_evolution(M1, M2, chi1, chi2, Omega_i, **kwargs)
+    inspiral = PostNewtonian.orbital_evolution(
+        M1, M2, chi1, chi2, Omega_i, **orbital_evolution_kwargs
+    )
     values = PostNewtonian.stack(inspiral.u)
 
     # Compute the waveform in the inertial frame
-    h = PostNewtonian.inertial_waveform(inspiral).to_numpy().T
+    waveform_pn_order = waveform_pn_order or PostNewtonian.typemax(PostNewtonian.Int)
+    h = PostNewtonian.inertial_waveform(
+        inspiral, ell_min=ell_min, ell_max=ell_max, PNOrder=waveform_pn_order
+    ).to_numpy().T
 
     w = WaveformModes(
         h,
         time=inspiral.t,
         modes_axis=1,
-        ell_min=2,
-        ell_max=8,
+        ell_min=ell_min,
+        ell_max=ell_max,
         M1=values[0, :].to_numpy(),
         M2=values[1, :].to_numpy(),
         chi1=values[2:5, :].to_numpy().T,

{sxs-2023.1.5.dist-info → sxs-2023.1.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: sxs
-Version: 2023.1.5
+Version: 2023.1.7
 Summary: Interface to data produced by the Simulating eXtreme Spacetimes collaboration
 Project-URL: Homepage, https://github.com/sxs-collaboration/sxs
 Project-URL: Documentation, https://sxs.readthedocs.io/
@@ -62,7 +62,8 @@ Requires-Dist: jupyterlab>=2.2.8; extra == 'ecosystem'
 Requires-Dist: line-profiler>=3.0.2; extra == 'ecosystem'
 Requires-Dist: matplotlib>=2.1.1; extra == 'ecosystem'
 Requires-Dist: memory-profiler>=0.57.0; extra == 'ecosystem'
-Requires-Dist: numpy-quaternion>=0.3.1; extra == 'ecosystem'
+Requires-Dist: numpy-quaternion>=2023.0.4; extra == 'ecosystem'
+Requires-Dist: numpy<2.0,>=1.20; extra == 'ecosystem'
 Requires-Dist: qgrid>=1.3.1; extra == 'ecosystem'
 Requires-Dist: rise>=5.6.1; extra == 'ecosystem'
 Requires-Dist: scri>=2020.8.18; (sys_platform != 'win32') and extra == 'ecosystem'

{sxs-2023.1.5.dist-info → sxs-2023.1.7.dist-info}/RECORD

@@ -1,5 +1,5 @@
 sxs/__init__.py,sha256=mDh2J6wLpie1GJT-Z3cmB3poEOvjXk-JsRu-p9U7zlI,2512
-sxs/__version__.py,sha256=fZ7HeugVNRT5R2lUnxHXFntEqqEL9_4owLQUXTsH_c4,25
+sxs/__version__.py,sha256=uKTUqFKNISqFgpM4PcPjcKxuSBUpc2Gf1l2ypuPqCW8,25
 sxs/handlers.py,sha256=odBzrk5f-Q3Nzm2_brKBGiSgo-x8q4DmCt0H0E6J8Ko,20929
 sxs/juliapkg.json,sha256=7gFXwLT2iVnQp9280M2WLj4uVgWHiNy1qixQK17BSqw,176
 sxs/time_series.py,sha256=c3doMFyRrC33_YjFO4CLGhBOECWECo4TGzrhetSG8EQ,39641
@@ -7,14 +7,14 @@ sxs/caltechdata/__init__.py,sha256=s-RXyBiImKsQenqJIU6NAjlsjOX7f1MkIIW9rPtWYyg,1
 sxs/caltechdata/catalog.py,sha256=E2nystCaMZLKxTlLgfbfpGkckfkLyIzhn3YeEI3nQYc,4914
 sxs/caltechdata/login.py,sha256=JaNyawXLSq37R1qbGM0fuTbfXmbHHnixEzU7nhwAGeE,21546
 sxs/catalog/__init__.py,sha256=9-WTMTPDmqqkFyIHOtEbPA6etXm3_RSRrLWvHtLrjLg,205
-sxs/catalog/catalog.py,sha256=GUgPQjoYdSzvlHyl0XGQtqC5lSjNxTt_DT5H0XHSeZ8,26481
+sxs/catalog/catalog.py,sha256=C9sG_kBNB7uaAVKP2_jqdD4gd62KjE-QeWkq9LVYZ_U,25586
 sxs/catalog/create.py,sha256=KL3zHljdLADeLfTDMTSkcVjIFim92Ylc-ziEvpiflEU,4734
 sxs/catalog/description.py,sha256=4eHMde4oGNp69jRmXCsfrIYJ4WK5HYgYFgXyF5htLDM,10830
 sxs/horizons/__init__.py,sha256=KR0aaEyreLHJItMBExGhG8bhRrHfPc0jBgPMsHysoEY,16265
 sxs/horizons/spec_horizons_h5.py,sha256=63cIGXuCEbJWrkRu3_mjL2gmssWtQ4axBTmg_wo_020,3642
 sxs/horizons/xor_multishuffle_bzip2.py,sha256=y4AKuxmLuj8K1pkdhIoSzENGyMu4uhpiPrBh-XisvK4,6536
 sxs/julia/GWFrames.py,sha256=WIm6TKm_2crM4TDY098XOKZVccUDzN8ndDN5RrG9eHI,2558
-sxs/julia/__init__.py,sha256=mu_hVj7YjXAPrzqb7W0bM-aWA9rawsVobX-6nabISTs,2405
+sxs/julia/__init__.py,sha256=jJ5nyg0z5ao92TuSLM9cQPgy0pddzZLf-jJ-ZI5ei0I,2985
 sxs/metadata/__init__.py,sha256=KCvJ9Cf1WhIZp-z28UzarKcmUAzV2BOv2gqKiorILjo,149
 sxs/metadata/metadata.py,sha256=_vGqMUbeiN0fecJj9f9f9ex56WgSZuwwBXykUuj1_ZI,27679
 sxs/utilities/__init__.py,sha256=Np27-TQRWfGP8HtDWlZcnZ_UL8QHBXLjXHGHGAbHD2g,4580
@@ -75,7 +75,7 @@ sxs/zenodo/api/__init__.py,sha256=EM_eh4Q8R5E0vIfMhyIR1IYFfOBu6vA0UTasgX9gHys,21
 sxs/zenodo/api/deposit.py,sha256=uor1irig-gBvrEQNg_Wb0ZuiXhZC9AeLwuJu3vB30e0,36946
 sxs/zenodo/api/login.py,sha256=Yz0ytgi81_5BpDzhrS0WPMXlvU2qUaCK8yn8zxfEbko,18007
 sxs/zenodo/api/records.py,sha256=nKkhoHZ95CTztHF9Zzaug5p7IiUCJG4Em1i-l-WqH6U,3689
-sxs-2023.1.5.dist-info/METADATA,sha256=wC81g5TWr0AhqJMgD6l65HunR_HtDCAOEVetJ010ND0,9362
-sxs-2023.1.5.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-sxs-2023.1.5.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2023.1.5.dist-info/RECORD,,
+sxs-2023.1.7.dist-info/METADATA,sha256=cj8WP_CTUDChjNgx0ayAv5Cl842e3sKhmd-PXZ-7dgg,9419
+sxs-2023.1.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sxs-2023.1.7.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2023.1.7.dist-info/RECORD,,

{sxs-2023.1.5.dist-info → sxs-2023.1.7.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.24.2
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any