sxs 2024.0.22__py3-none-any.whl → 2024.0.24__py3-none-any.whl

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2024.0.22"
+__version__ = "2024.0.24"

sxs/simulations/simulation.py

@@ -593,7 +593,10 @@ class SimulationBase:
 
         """
         from ..waveforms.format_handlers.lvc import to_lvc_conventions
-        strain = self.load_waveform(*self.strain_path, transform_to_inertial=False)
+        strain = self.load_waveform(
+            *self.strain_path,
+            transform_to_inertial=False,
+        )
         return to_lvc_conventions(strain, self.horizons, **kwargs)
 
 
@@ -683,8 +686,6 @@ class Simulation_v1(SimulationBase):
             transform_to_inertial=transform_to_inertial
         )
         w.metadata = self.metadata
-        if not transform_to_inertial:
-            w = w.to_corotating_frame()
         return w
 
 

sxs/simulations/simulations.py

@@ -57,13 +57,17 @@ class SimulationsDataFrame(pd.DataFrame):
     
     @property
     def IMR(self):
-        """Restrict dataframe to just BBH systems with inspiral, merger, and ringdown
+        """Restrict dataframe to just BBH IMR systems
         
+        "IMR" stands for inspiral, merger, and ringdown.  Systems that
+        will *not* be in this group include simulations that
+        correspond to physical IMR systems, but were not continued
+        through the merger.
+
         The criteria used here are just that the reference
-        eccentricity and remnant mass are actual (finite)
-        numbers.  Currently, at least, the existence of a
-        measured eccentricity means that the system is not
-        hyperbolic or head-on.
+        eccentricity and remnant mass are actual (finite) numbers.
+        Currently, at least, the existence of a measured eccentricity
+        means that the system is not hyperbolic or head-on.
         """
         df = self.BBH
         return type(df)(df[

sxs/waveforms/__init__.py

@@ -15,6 +15,7 @@ from .format_handlers import (
     rotating_paired_diff_multishuffle_bzip2,
     rotating_paired_xor_multishuffle_bzip2,
     spectre_cce_v1,
+    grathena,
 )
 from .format_handlers.lvc import to_lvc_conventions
 from . import memory, transformations, alignment

sxs/waveforms/format_handlers/grathena.py

@@ -0,0 +1,93 @@
+from ... import sxs_directory
+from . import nrar
+
+
+def load(file, **kwargs):
+    """Load a waveform from a GR-Athena++ `tar` file.
+
+    Parameters
+    ==========
+    file : str
+        The path to the `tar` file containing the waveform data.
+
+    Other Parameters
+    ================
+    subfile : str
+        The name of the subfile within the `tar` file to read.
+        Default is "rh_CCE_GeometricUnits.h5".  Other potentially
+        useful values replace "rh" with "rPsi4" and/or "CCE" with
+        "Asymptotic" or "FiniteRadii".
+    radius : str
+        The extraction radius to use.  Default is "50.00".
+    
+    Notes
+    =====
+    Waveforms from GR-Athena++ are distributed as `tar` files
+    containing a set of HDF5 files, containing CCE data,
+    "extrapolated" data (where "extrapolation" refers to the
+    single-radius PN-based correction method that Nakano introduced),
+    or finite-radius data, for either Psi4 or h.  Each of those files
+    is NRAR-formatted exactly like the old SXS data.  We could extract
+    the `tar` file, and then use the `nrar.load` function to read the
+    data.  Alternatively — as is done here — we could just use the
+    `tar` file as a file-like object, and pass that to the `nrar.load`
+    function.  This is a bit more efficient, and is preferred if we
+    intend to directly use the `tar` files.
+
+    The `tar` file is generally named with the resolution of the
+    simulation, which — for the initial catalog at least — may be any
+    of 128, 192, 256, 320, or 384.
+
+    Within the `tar` file, we have files like the following — though
+    "384" may be replaced by any resolution:
+
+    * "384/rPsi4_Asymptotic_GeometricUnits.h5"
+    * "384/rPsi4_CCE_GeometricUnits.h5"
+    * "384/rPsi4_FiniteRadii_GeometricUnits.h5"
+    * "384/rh_Asymptotic_GeometricUnits.h5"
+    * "384/rh_CCE_GeometricUnits.h5"
+    * "384/rh_FiniteRadii_GeometricUnits.h5"
+
+    And finally, within each of those h5 files, we have waveforms
+    corresponding to a series of extraction radii, which may include
+
+    * "50.00"
+    * "60.00"
+    * "70.00"
+    * "80.00"
+    * "90.00"
+    * "100.00"
+    * "120.00"
+    * "140.00"
+
+    (Note the two 0s after the decimal point.)  The `FiniteRadii` and
+    `Asymptotic` data generally contain all of the above radii, while
+    the `CCE` data generally contains only the "50.00" and "100.00"
+    radius.  The catalog paper uses "50.00" as the radius when
+    discussing properties of the waveforms, possibly because CCE only
+    "exhibits convergence behavior" for data from that radius.  They
+    also use "100.00" for "extrapolated" waveforms some times.  The
+    default used here is "50.00".
+
+    """
+    from pathlib import Path
+    import tarfile
+
+    resolution = Path(file).stem
+    subfile = kwargs.pop("subfile", "rh_CCE_GeometricUnits.h5")
+    radius = kwargs.pop("radius", "50.00")
+
+    with tarfile.open(file, "r") as tf:
+        tf_names = [tfi.name for tfi in tf]
+        index = tf_names.index(f"{resolution}/{subfile}")
+        h5file = tf.extractfile(list(tf)[index])
+        w = nrar.load(
+            h5file,
+            h5_group=radius,
+            frame_type=nrar.Inertial,
+            data_type=nrar.h,
+            m_is_scaled_out=True,
+            r_is_scaled_out=True,
+        )
+
+    return w

sxs/waveforms/format_handlers/lvc.py

@@ -202,6 +202,7 @@ def to_lvc_conventions(
     # If `phi_ref` and `inclination` are not None, return polarizations
     if phi_ref is not None:
         hp, hc = h.evaluate(inclination, π/2 - phi_ref).ndarray.view((float, 2)).T
+        hc *= -1  # Because h = hp - i hc
         return h.t, hp, hc, dynamics_dict
     else:
         # Could do `dict(WaveformModesDict(h))` to convert to a plain dict

sxs/waveforms/format_handlers/nrar.py

@@ -148,6 +148,7 @@ def load(file, **kwargs):
 
     """
     import pathlib
+    import tarfile
     import re
     import h5py
     import quaternionic
@@ -161,41 +162,53 @@ def load(file, **kwargs):
     w_attributes = {}
 
     # Get an h5py handle to the desired part of the h5 file
-    file_str = str(file)
-    split = file_str.rsplit(".h5", 1)  # Raises ValueError if ".h5" is not in the string
-    if len(split) != 2:
-        split = file_str.rsplit(".hdf5", 1)
-        file_ending = ".hdf5"
-    else:
-        file_ending = ".h5"
-    if len(split) != 2:
-        raise ValueError(f"Could not find a valid HDF5 filename ending in '{file_str}'")
-    file_str, root_group = split
-    file_str = file_str + file_ending
-    if not root_group:
+    if isinstance(file, tarfile.ExFileObject):
+        file_path = file
+        file_name = pathlib.Path(file.name).name
+        file_str = f"{file_name}"
+        file_dir = pathlib.Path(file.name).parent
         root_group = kwargs.pop("h5_group", "")
-    if not root_group:
-        extrapolation_order = kwargs.pop("extrapolation_order", None)
-        if extrapolation_order is None:
-            warning = "\nCould not find root group as `h5_group` or as `extrapolation_order`; returning all groups"
-            warnings.warn(warning)
-        elif extrapolation_order is Ellipsis:
-            pass
-        elif isinstance(extrapolation_order, str):
-            root_group = extrapolation_order
-        elif extrapolation_order == -1:
-            root_group = "OutermostExtraction.dir"
+    else:
+        file_str = str(file)
+        split = file_str.rsplit(".h5", 1)  # Raises ValueError if ".h5" is not in the string
+        if len(split) != 2:
+            split = file_str.rsplit(".hdf5", 1)
+            file_ending = ".hdf5"
         else:
-            root_group = f"Extrapolated_N{extrapolation_order}.dir"
+            file_ending = ".h5"
+        if len(split) != 2:
+            raise ValueError(f"Could not find a valid HDF5 filename ending in '{file_str}'")
+        file_str, root_group = split
+        file_str = file_str + file_ending
+        if not root_group:
+            root_group = kwargs.pop("h5_group", "")
+        if not root_group:
+            extrapolation_order = kwargs.pop("extrapolation_order", None)
+            if extrapolation_order is None:
+                warning = "\nCould not find root group as `h5_group` or as `extrapolation_order`; returning all groups"
+                warnings.warn(warning)
+            elif extrapolation_order is Ellipsis:
+                pass
+            elif isinstance(extrapolation_order, str):
+                root_group = extrapolation_order
+            elif extrapolation_order == -1:
+                root_group = "OutermostExtraction.dir"
+            else:
+                root_group = f"Extrapolated_N{extrapolation_order}.dir"
 
-    file_path = pathlib.Path(file_str).expanduser().resolve()
-    file_name = file_path.name
-    file_dir = file_path.parent
+        file_path = pathlib.Path(file_str).expanduser().resolve()
+        file_name = file_path.name
+        file_dir = file_path.parent
 
     with h5py.File(file_path, "r") as f_h5:
         if root_group:
             if root_group not in f_h5:
-                raise ValueError(f"Input root group '{root_group}' was not found in '{file_path}'")
+                message = [
+                    f"Input root group '{root_group}' was not found in '{file_path}'",
+                    "Available groups are:",
+                ]
+                f_h5.visit(lambda s: message.append(f"\t{s}"))
+                raise ValueError("\n".join(message))
             f = f_h5[root_group]
         else:
             return KeyPassingDict(**{

sxs/waveforms/waveform_modes.py

@@ -3,6 +3,7 @@
 import re
 import numbers
 from collections.abc import MutableMapping
+import warnings
 import numpy as np
 from scipy.interpolate import CubicSpline
 from scipy.optimize import minimize_scalar
@@ -1127,6 +1128,9 @@ class WaveformModes(WaveformMixin, TimeSeries):
             raised.
 
         """
+        if self.frame_type == "corotating":
+            warnings.warn("This waveform is already in a corotating frame; returning original.")
+            return self
         frame, omega = self.corotating_frame(
             R0=R0,
             tolerance=tolerance,

{sxs-2024.0.22.dist-info → sxs-2024.0.24.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2024.0.22
+Version: 2024.0.24
 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/

{sxs-2024.0.22.dist-info → sxs-2024.0.24.dist-info}/RECORD

@@ -1,5 +1,5 @@
 sxs/__init__.py,sha256=hbydsXWR88sFiKExPJ1NHWGEvWRbbJBjSc1irSMYKgY,2623
-sxs/__version__.py,sha256=I4E6gGsS8NeMVLO7_zs_eRHp09cSVrztULxx3C2s-XA,26
+sxs/__version__.py,sha256=mmwyMBxxhpLBrZ0NORTAKzSf8R7pTJXf2m8m6-6FouM,26
 sxs/handlers.py,sha256=Nc1_aDKm_wDHg2cITI_ljbqU4VRWpwQ7fdgy3c1XcE8,17531
 sxs/juliapkg.json,sha256=higH1UDu30K_PN6-o7lAz0j1xjgYEiCCYBAc-Iaw1Iw,178
 sxs/time_series.py,sha256=OKaLg8tFyrtKcef7900ri-a0C6A8wKxA68KovZXvH6I,41081
@@ -19,8 +19,8 @@ sxs/metadata/__init__.py,sha256=KCvJ9Cf1WhIZp-z28UzarKcmUAzV2BOv2gqKiorILjo,149
 sxs/metadata/metadata.py,sha256=y6X7LcsJKiZFjBPTwRHGtsT2uHf2s0r0OG_EGjD27pE,27663
 sxs/simulations/__init__.py,sha256=GrZym0PHTULDg_hyFmISNzDfqVLz_hQo-djbgecZs54,134
 sxs/simulations/local.py,sha256=CEu8PzumNB1-JA05M4tYSW_UZVrldKzOB5T_I3pFWls,5789
-sxs/simulations/simulation.py,sha256=R2Nf3z3XEu92-oiHLeynGMpjqQu5iYV25L8K9lFrOcY,34204
-sxs/simulations/simulations.py,sha256=qnYHKd6wz5auYweOZeDDMm4ZzG3s-lqOltQCxEZBrmU,23594
+sxs/simulations/simulation.py,sha256=pSwC82oeoaQTs2TB7uJLl0pScN6b9AgHdmTxf_iRKB4,34161
+sxs/simulations/simulations.py,sha256=YttUK3WTU786OrHKMWya8myuMmmjMbazfIVs7A8FPlk,23781
 sxs/utilities/__init__.py,sha256=WSStlqljfgQheMxHGfuofSc5LdmASGvO3FNO3f_zaT0,4806
 sxs/utilities/bitwise.py,sha256=G9ZNYgwDQRhq5wbDf-p2HcUqkEP_IRDiQoXW4KyU17k,13205
 sxs/utilities/dicts.py,sha256=CCpm3upG_9SRj9gjawukSUfaJ5asF-XRG2ausEXhYyg,695
@@ -55,18 +55,19 @@ sxs/utilities/references/fairchild_report.py,sha256=MUnYQD7zJcz202Vt3-j9ueXglthG
 sxs/utilities/references/inspire.py,sha256=kDjY-UFJT-VTS3yJOT8fT6LJG-pRrX9TK8nv3RZqrbo,8431
 sxs/utilities/references/journal_abbreviations.py,sha256=SuRXcr4rv9YPbXD4mzujSvE7M6KS1lwELimuyn7mfCE,31018
 sxs/utilities/references/references.py,sha256=29rPUZKw3dztXQLRDEt1hGYjZaONFd0qX--xQxzOmUU,418
-sxs/waveforms/__init__.py,sha256=Z9MYCDhGeXN002vD_umirAF5VdAFunL4RiFSvB_gWnM,1136
+sxs/waveforms/__init__.py,sha256=FPu_MFwfzcLsWhvoLm_AXRLz59eBODes4MY2_taTE5c,1150
 sxs/waveforms/alignment.py,sha256=YHtOyOUBxdaXMIgjdeGvJqU0zN5UOUChrAOEZdkU45Y,12418
 sxs/waveforms/memory.py,sha256=1BOov3QJl9wexgGt8HA8MqVZZfLKbykff5pRVzLiILo,7763
 sxs/waveforms/mode_utilities.py,sha256=gxsW-hunCoIReBVv9IrkGLdshr0rmztbH-JRgD6D9z0,5253
 sxs/waveforms/transformations.py,sha256=S5C-xnCk2umZlVsYgciyp7VMGZA8NI6md7OZp72upJU,9124
 sxs/waveforms/waveform_grid.py,sha256=aBlcsudj1XozZD7n42sh6-nzysKNalAdHJkVQ7M6fE4,180
 sxs/waveforms/waveform_mixin.py,sha256=S0RNe2HkwnqdCyGEarGYmoXD_DkTWGorsiGGIBWOam8,1179
-sxs/waveforms/waveform_modes.py,sha256=L6FSreVUSz60EN15A57c3qiwtML1QU-wdr9DYHaINk0,56919
+sxs/waveforms/waveform_modes.py,sha256=svvEHHyOez6MFcpVsIFsiLJqvGrb_saCgSHVBK1XErk,57100
 sxs/waveforms/waveform_signal.py,sha256=Ojrt6DSDdleB0qmu6UwjjPnYdaWsrjnpBA_8dhnM_q4,182
 sxs/waveforms/format_handlers/__init__.py,sha256=0wsnuBYCYsCkN19L2ipga7BtigvPyBcqiy_4qrzmLpE,50
-sxs/waveforms/format_handlers/lvc.py,sha256=dY4rLC1riu1NWyPGc2kSsIsbVM5FgtMbEqca5S6odgk,7775
-sxs/waveforms/format_handlers/nrar.py,sha256=UxD3V59taGXQ_ycSsRsQod0XJp7rKEjqRetrjqTODnI,20946
+sxs/waveforms/format_handlers/grathena.py,sha256=Ng0eEo3Um_WOYe63waaOYxy5Qu8m7-piCjgB3XguUdU,3294
+sxs/waveforms/format_handlers/lvc.py,sha256=gdXYqa8Bn8jCSIRIshMP399WO9ZMtkNtkAQiuzqhH_0,7817
+sxs/waveforms/format_handlers/nrar.py,sha256=3ycVoqQcWAAixV3mKp58_wUhYBHt6QeLv2YGSvy-EGM,21538
 sxs/waveforms/format_handlers/rotating_paired_diff_multishuffle_bzip2.py,sha256=C19-9VkQ5dt9I7GHkeFrF56k_BbFPHXIMX_xmmBj7ww,27477
 sxs/waveforms/format_handlers/rotating_paired_xor_multishuffle_bzip2.py,sha256=pFEJIlb6OQQNhv6r48ALFnZMKNZjuQY55ydWBADCDgU,2348
 sxs/waveforms/format_handlers/spectre_cce_v1.py,sha256=nh57zbG_uWJZQVhMrz7H05fpsjl1X6oaita8aTRcWxU,3963
@@ -79,7 +80,7 @@ sxs/zenodo/api/__init__.py,sha256=EM_eh4Q8R5E0vIfMhyIR1IYFfOBu6vA0UTasgX9gHys,21
 sxs/zenodo/api/deposit.py,sha256=J4RGvGjh0cEOrN4bBZWEDcPAhNscqB2fzLlvRZ5HTHM,36948
 sxs/zenodo/api/login.py,sha256=Yz0ytgi81_5BpDzhrS0WPMXlvU2qUaCK8yn8zxfEbko,18007
 sxs/zenodo/api/records.py,sha256=nKkhoHZ95CTztHF9Zzaug5p7IiUCJG4Em1i-l-WqH6U,3689
-sxs-2024.0.22.dist-info/METADATA,sha256=Fr9NWKGw4rnKeDxR1GENCk5nQ2JYSwS4pHPws9nZSB8,9223
-sxs-2024.0.22.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-sxs-2024.0.22.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2024.0.22.dist-info/RECORD,,
+sxs-2024.0.24.dist-info/METADATA,sha256=JcN5Id2HHk-gLksiFD8wAHbJ_FZTk6C93dah3OjSH3k,9223
+sxs-2024.0.24.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+sxs-2024.0.24.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2024.0.24.dist-info/RECORD,,