sxs 2024.0.18__py3-none-any.whl → 2024.0.20__py3-none-any.whl

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2024.0.18"
+__version__ = "2024.0.20"

sxs/simulations/simulations.py

@@ -1,7 +1,7 @@
 """Container interface to the catalog of SXS simulations"""
 
-import functools
 import collections
+import numpy as np
 import pandas as pd
 
 class SimulationsDataFrame(pd.DataFrame):
@@ -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,21 @@ 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.
+        """
+        return type(self)(self[
+            np.isfinite(self["reference_eccentricity"])
+            & np.isfinite(self["remnant_mass"])
+        ])
 
 
 class Simulations(collections.OrderedDict):
@@ -70,6 +85,20 @@ class Simulations(collections.OrderedDict):
 
     simulations = sxs.load("simulations")
     ```
+
+    Note SXS members may also wish to read a local copy of the
+    simulation annex, which can be done with
+    ```python
+    simulations = sxs.load("simulations", annex_dir="/path/to/SimulationAnnex.git")
+    ```
+    which will re-read the annex (which may take about a minute), or
+    ```python
+    simulations = sxs.load("simulations", local=True)
+    ```
+    if the annex has not been updated since the last time you
+    used the `annex_dir` argument.  Once you have done this,
+    calls to `sxs.load` will automatically use this local copy
+    of the simulations.
     """
     last_modified_url = "https://api.github.com/repos/sxs-collaboration/sxs/contents/simulations.json?ref=simulations"
     url = "https://github.com/sxs-collaboration/sxs/raw/simulations/simulations.json"

{sxs-2024.0.18.dist-info → sxs-2024.0.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2024.0.18
+Version: 2024.0.20
 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.18.dist-info → sxs-2024.0.20.dist-info}/RECORD

@@ -1,5 +1,5 @@
 sxs/__init__.py,sha256=hbydsXWR88sFiKExPJ1NHWGEvWRbbJBjSc1irSMYKgY,2623
-sxs/__version__.py,sha256=azdCDT3ktM4BaKnUzpwFNRXrkMHbYmM9S-ljaxcAThw,26
+sxs/__version__.py,sha256=g3GeSoqvlteY_p0wwNiA8baVXYkyWB0EKHrtp1fFYHc,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
@@ -20,7 +20,7 @@ sxs/metadata/metadata.py,sha256=y6X7LcsJKiZFjBPTwRHGtsT2uHf2s0r0OG_EGjD27pE,2766
 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=8R3EVfq0OLT2wAE5vjLbx4gCte79M7depb-SB6PLSRU,21971
+sxs/simulations/simulations.py,sha256=Y8wNfumdhQyX0SmdXdE8dGRNUawyxwyNTN5WS_2JsXw,23112
 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
@@ -79,7 +79,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.18.dist-info/METADATA,sha256=bV11FyEjtxKa73tyv_uYgPYs7vTxc6GkDmzBKU-EpWU,9245
-sxs-2024.0.18.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-sxs-2024.0.18.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2024.0.18.dist-info/RECORD,,
+sxs-2024.0.20.dist-info/METADATA,sha256=hjlCnxbPf6VDHKdDbv63C_v1J0nqsR3VgSpes_GVROM,9245
+sxs-2024.0.20.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+sxs-2024.0.20.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2024.0.20.dist-info/RECORD,,