sxs 2024.0.13__tar.gz → 2024.0.14__tar.gz

{sxs-2024.0.13 → sxs-2024.0.14}/CITATION.cff

@@ -10,5 +10,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2024.0.13
+version: 2024.0.14
 date-released: 2024-10-09

{sxs-2024.0.13 → sxs-2024.0.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2024.0.13
+Version: 2024.0.14
 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.14/sxs/__version__.py

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

{sxs-2024.0.13 → sxs-2024.0.14}/sxs/handlers.py

@@ -286,6 +286,9 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
         elif location == "local_simulations":
             return Simulations.local(download=download)
 
+        elif location == "dataframe":
+            return Simulations.load(download=download).dataframe
+
         elif sxs_id_version_lev_exact_re.match(location):
             return Simulation(location, download=download, cache=cache, progress=progress, **kwargs)
 

{sxs-2024.0.13 → sxs-2024.0.14}/sxs/simulations/local.py

@@ -119,6 +119,7 @@ def local_simulations(annex_dir):
                 [d for d in dirnames if d.startswith("Lev")]
             )[-1]
             metadata = Metadata.load(dirpath / highest_lev / "metadata")
+            metadata = metadata.add_standard_parameters()
 
             metadata["files"] = {
                 p2i(file.relative_to(dirpath)): {"link": str(file)}

{sxs-2024.0.13 → sxs-2024.0.14}/sxs/simulations/simulations.py

@@ -2,6 +2,58 @@
 
 import functools
 import collections
+import pandas as pd
+
+class SimulationsDataFrame(pd.DataFrame):
+    @property
+    def BHBH(self):
+        """Restrict dataframe to just binary black hole systems"""
+        return type(self)(self[self["object_types"] == "BHBH"])
+    BBH = BHBH
+    
+    @property
+    def BHNS(self):
+        """Restrict dataframe to just black hole-neutron star systems"""
+        return type(self)(self[self["object_types"] == "BHNS"])
+    NSBH = BHNS
+    
+    @property
+    def NSNS(self):
+        """Restrict dataframe to just binary neutron star systems"""
+        return type(self)(self[self["object_types"] == "NSNS"])
+    BNS = NSNS
+
+    @property
+    def noneccentric(self):
+        """Restrict dataframe to just non-eccentric systems (e<1e-3)"""
+        return type(self)(self[self["reference_eccentricity"] < 1e-3])
+
+    @property
+    def eccentric(self):
+        """Restrict dataframe to just eccentric systems (e>=1e-3)"""
+        return type(self)(self[self["reference_eccentricity"] >= 1e-3])
+    
+    @property
+    def nonprecessing(self):
+        """Restrict dataframe to just nonprecessing systems
+        
+        The criterion used here is that the sum of the x-y components
+        of the spins is less than 1e-3 at the reference time.
+        """
+        return type(self)(self[
+            (self["reference_chi1_perp"] + self["reference_chi2_perp"]) < 1e-3
+        ])
+    
+    @property
+    def precessing(self):
+        """Restrict dataframe to just precessing systems
+        
+        The criterion used here is that the sum of the x-y components
+        of the spins is at least 1e-3 at the reference time.
+        """
+        return type(self)(self[
+            (self["reference_chi1_perp"] + self["reference_chi2_perp"]) >= 1e-3
+        ])
 
 
 class Simulations(collections.OrderedDict):
@@ -110,7 +162,14 @@ class Simulations(collections.OrderedDict):
         with local_path.open("r") as f:
             local_simulations = json.load(f)
         simulations = cls.load(download)
+        doi_versions = {
+            k: v["DOI_versions"]
+            for k,v in simulations.items()
+            if "DOI_versions" in v
+        }
         simulations.update(local_simulations)
+        for k,v in doi_versions.items():
+            simulations[k]["DOI_versions"] = v
         simulations.__file__ = str(local_path)
         return simulations
 
@@ -315,7 +374,7 @@ class Simulations(collections.OrderedDict):
                 dt = pd.to_datetime("1970-1-1").tz_localize("UTC")
             return dt
 
-        sims_df = pd.concat((
+        sims_df = SimulationsDataFrame(pd.concat((
             simulations["reference_time"].map(floater),
             simulations["reference_mass_ratio"].map(floater),
             simulations["reference_dimensionless_spin1"].map(three_vec),
@@ -387,7 +446,7 @@ class Simulations(collections.OrderedDict):
             simulations["date_run_earliest"].map(datetime_from_string),
             simulations["date_run_latest"].map(datetime_from_string),
             simulations["date_postprocessing"].map(datetime_from_string),
-        ), axis=1)
+        ), axis=1))
 
         sims_df.insert(0, "deprecated", (
             ~sims_df.superseded_by.isna()

sxs-2024.0.13/sxs/__version__.py

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