sxs 2024.0.21__tar.gz → 2024.0.23__tar.gz

{sxs-2024.0.21 → sxs-2024.0.23}/.github/workflows/build.yml

@@ -79,7 +79,7 @@ jobs:
 
       - name: Upload coverage
         if: "matrix.python-version == '3.12' && matrix.os == 'ubuntu-latest'"
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 

{sxs-2024.0.21 → sxs-2024.0.23}/CITATION.cff

@@ -10,5 +10,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2024.0.21
-date-released: 2024-10-24
+version: 2024.0.23
+date-released: 2024-11-24

{sxs-2024.0.21 → sxs-2024.0.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2024.0.21
+Version: 2024.0.23
 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/
@@ -26,7 +26,6 @@ License: The MIT License (MIT)
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
-License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License

sxs-2024.0.23/sxs/__version__.py

@@ -0,0 +1 @@
+__version__ = "2024.0.23"

{sxs-2024.0.21 → sxs-2024.0.23}/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-2024.0.21 → sxs-2024.0.23}/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-2024.0.21 → sxs-2024.0.23}/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-2024.0.23/sxs/waveforms/format_handlers/grathena.py

@@ -0,0 +1,89 @@
+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_Asymptotic_GeometricUnits.h5".  Other
+        potentially useful values replace "rh" with "rPsi4" and/or
+        "Asymptotic" with "CCE" or "FiniteRadii".
+    radius : str
+        The extraction radius to use.  Default is "100.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.
+
+    """
+
+    from pathlib import Path
+    import tarfile
+
+    resolution = Path(file).stem
+    subfile = kwargs.pop("subfile", "rh_Asymptotic_GeometricUnits.h5")
+    radius = kwargs.pop("radius", "100.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-2024.0.21 → sxs-2024.0.23}/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-2024.0.21 → sxs-2024.0.23}/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-2024.0.21 → sxs-2024.0.23}/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.21 → sxs-2024.0.23}/tests/test_waveform_rotations.py

@@ -164,6 +164,7 @@ def test_corotating_frame():
     R0 = quaternionic.array.random().normalized
     R_in = R0 * np.exp(quaternionic.array([0, 0, 0, omega / 2]) * w.t)
     w_rot = w.copy().rotate(R_in.conjugate())
+    w_rot._metadata["frame_type"] = "inertial"
     R_out = w_rot.corotating_frame(R0=R0, tolerance=1e-12)
     assert np.allclose(R_in.ndarray, R_out.ndarray, atol=1e-10, rtol=0.0), (
         f"\nR_in = {R_in}\n"

sxs-2024.0.21/sxs/__version__.py

@@ -1 +0,0 @@
-__version__ = "2024.0.21"