sxs 2024.0.19__tar.gz → 2024.0.21__tar.gz

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2024.0.19
+Version: 2024.0.21
 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.21/sxs/__version__.py

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

{sxs-2024.0.19 → sxs-2024.0.21}/sxs/simulations/simulations.py

@@ -1,15 +1,15 @@
 """Container interface to the catalog of SXS simulations"""
 
-import functools
 import collections
+import numpy as np
 import pandas as pd
 
 class SimulationsDataFrame(pd.DataFrame):
     @property
-    def BHBH(self):
+    def BBH(self):
         """Restrict dataframe to just binary black hole systems"""
         return type(self)(self[self["object_types"] == "BHBH"])
-    BBH = BHBH
+    BHBH = BBH
     
     @property
     def BHNS(self):
@@ -26,12 +26,12 @@ class SimulationsDataFrame(pd.DataFrame):
     @property
     def noneccentric(self):
         """Restrict dataframe to just non-eccentric systems (e<1e-3)"""
-        return type(self)(self[self["reference_eccentricity"] < 1e-3])
+        return type(self)(self[self["reference_eccentricity_bound"] < 1e-3])
 
     @property
     def eccentric(self):
         """Restrict dataframe to just eccentric systems (e>=1e-3)"""
-        return type(self)(self[self["reference_eccentricity"] >= 1e-3])
+        return type(self)(self[self["reference_eccentricity_bound"] >= 1e-3])
     
     @property
     def nonprecessing(self):
@@ -54,6 +54,35 @@ class SimulationsDataFrame(pd.DataFrame):
         return type(self)(self[
             (self["reference_chi1_perp"] + self["reference_chi2_perp"]) >= 1e-3
         ])
+    
+    @property
+    def IMR(self):
+        """Restrict dataframe to just BBH systems with inspiral, merger, and ringdown
+        
+        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.
+        """
+        df = self.BBH
+        return type(df)(df[
+            np.isfinite(df["reference_eccentricity"])
+            & np.isfinite(df["remnant_mass"])
+        ])
+    
+    @property
+    def hyperbolic(self):
+        """Restrict dataframe to just hyperbolic systems
+        
+        The criterion used here is that the (normalized) ADM mass is
+        greater than 1.
+        """
+        total_mass = self["initial_mass1"] + self["initial_mass2"]
+        normalized_ADM = self["initial_ADM_energy"] / total_mass
+        return type(self)(self[
+            np.isfinite(total_mass) & (total_mass > 0) & (normalized_ADM > 1)
+        ])
 
 
 class Simulations(collections.OrderedDict):

sxs-2024.0.19/sxs/__version__.py

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