sxs 2024.0.13__py3-none-any.whl → 2024.0.15__py3-none-any.whl

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2024.0.13"
+__version__ = "2024.0.15"

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/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/simulations/simulation.py

@@ -97,14 +97,20 @@ def Simulation(location, *args, **kwargs):
     """
     from .. import load, sxs_directory
 
+    # Load the simulation catalog
+    simulations = load("simulations")
+
     # Extract the simulation ID, version, and Lev from the location string
     simulation_id, input_version = sxs_id_and_version(location)
     if not simulation_id:
-        raise ValueError(f"Invalid SXS ID in '{simulation_id}'")
+        if location in simulations:
+            simulation_id = location.split("/Lev")[0]
+            input_version = "v0.0"
+        else:
+            raise ValueError(f"Invalid SXS ID in '{simulation_id}'")
     input_lev_number = lev_number(location)  # Will be `None` if not present
 
-    # Load the simulation catalog and check if simulation ID exists in the catalog
-    simulations = load("simulations")
+    # Check if simulation ID exists in the catalog
     if simulation_id not in simulations:
         raise ValueError(f"Simulation '{simulation_id}' not found in simulation catalog")
 
@@ -113,7 +119,7 @@ def Simulation(location, *args, **kwargs):
     series = simulations.dataframe.loc[simulation_id]
 
     # Check if the specified version exists in the simulation catalog
-    if input_version not in metadata.DOI_versions:
+    if input_version != "v0.0" and input_version not in metadata.DOI_versions:
         raise ValueError(f"Version '{input_version}' not found in simulation catalog for '{simulation_id}'")
 
     # Set various pieces of information about the simulation
@@ -205,7 +211,7 @@ def Simulation(location, *args, **kwargs):
         sim = Simulation_v1(
             metadata, series, version, sxs_id_stem, sxs_id, url, files, lev_numbers, output_lev_number, location, *args, **kwargs
         )
-    elif 2 <= version_number < 3.0:
+    elif 2 <= version_number < 3.0 or version == "v0.0":
         sim = Simulation_v2(
             metadata, series, version, sxs_id_stem, sxs_id, url, files, lev_numbers, output_lev_number, location, *args, **kwargs
         )

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,13 +162,19 @@ 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
 
     @classmethod
-    @functools.lru_cache()
-    def load(cls, download=None):
+    def load(cls, download=None, *, local=False):
         """Load the catalog of SXS simulations
 
         Note that — unlike most SXS data files — the simulations file is updated
@@ -136,6 +194,12 @@ class Simulations(collections.OrderedDict):
             if that fails, and only raise an error if the simulations is not found in the
             cache.  Note that this ignores the sxs configuration file entirely.
 
+        Keyword-only Parameters
+        -----------------------
+        local : {None, bool}, optional
+            If True, this function will load local simulations from the sxs cache.  To
+            prepare the cache, you may wish to call `sxs.write_local_simulations`.
+
         See Also
         --------
         sxs.sxs_directory : Locate cache directory
@@ -148,6 +212,13 @@ class Simulations(collections.OrderedDict):
         from .. import sxs_directory, read_config
         from ..utilities import download_file
 
+        if hasattr(cls, "_simulations"):
+            return cls._simulations
+
+        if local:
+            cls._simulations = cls.local(download=download)
+            return cls._simulations
+
         progress = read_config("download_progress", True)
 
         remote_timestamp = cls.remote_timestamp(download is not False)  # Test for literal `False`
@@ -209,6 +280,8 @@ class Simulations(collections.OrderedDict):
 
         sims = cls(simulations)
         sims.__file__ = str(cache_path)
+
+        cls._simulations = sims
         return sims
 
     @classmethod
@@ -315,7 +388,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 +460,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.dist-info → sxs-2024.0.15.dist-info}/METADATA

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

@@ -1,6 +1,6 @@
 sxs/__init__.py,sha256=hbydsXWR88sFiKExPJ1NHWGEvWRbbJBjSc1irSMYKgY,2623
-sxs/__version__.py,sha256=ccSsvMKSEb0DDrHig0GNWueoK8ceho4S2fY9o4nd_po,26
-sxs/handlers.py,sha256=bnQ1pH9EXZV_1iW9zf_WA61CfsavFjbcA0gmtoY5KWY,16770
+sxs/__version__.py,sha256=BGqJJdNZR4le1Z34PSJ09M4Ey3xZUp0qPiEiOTKJjOw,26
+sxs/handlers.py,sha256=B3mCX7sPtnyYpkzuDCUrpHL4pmHDo9I7UjaHAIJ2s5A,16874
 sxs/juliapkg.json,sha256=higH1UDu30K_PN6-o7lAz0j1xjgYEiCCYBAc-Iaw1Iw,178
 sxs/time_series.py,sha256=OKaLg8tFyrtKcef7900ri-a0C6A8wKxA68KovZXvH6I,41081
 sxs/caltechdata/__init__.py,sha256=s-RXyBiImKsQenqJIU6NAjlsjOX7f1MkIIW9rPtWYyg,14761
@@ -18,9 +18,9 @@ sxs/julia/__init__.py,sha256=uSLP_xfU-GZG7IO5vs0TEkCR4LH8aBYMF-852wDY3kI,3490
 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=Q3BZoLT8sPx5gLbNgbyswQvk9kebts-vcXipaR3veCA,5731
-sxs/simulations/simulation.py,sha256=WgxvZexjBH9fwd5qKID7YwvA1wglHerXwS_VQT1LlkY,33915
-sxs/simulations/simulations.py,sha256=AVoNcsW0RN4GGHiPEdVilUXN1jMGAGm8FfiWMIF3ZaU,19127
+sxs/simulations/local.py,sha256=CEu8PzumNB1-JA05M4tYSW_UZVrldKzOB5T_I3pFWls,5789
+sxs/simulations/simulation.py,sha256=UN7cQ8y1Ccr3TPI8TyMAr9hvzQuM8NcitqXJJ0IXNPs,34110
+sxs/simulations/simulations.py,sha256=hMmA0_EC9JzTcNFUFDbegZgNw4XwMdKnjKkg-vucpLE,21621
 sxs/utilities/__init__.py,sha256=KTtsBKblP02t20anSzV_7tucRUw_bFObY5my5ZuJEBU,4793
 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.13.dist-info/METADATA,sha256=7lXzXHpcbDsfFGk4PPNrfY7Rhzkr2spdIWGv7_H4jME,9245
-sxs-2024.0.13.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-sxs-2024.0.13.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2024.0.13.dist-info/RECORD,,
+sxs-2024.0.15.dist-info/METADATA,sha256=GzByjeNRag_EYwribITnNpS6_rkI5GA4l15YufjxQ7E,9245
+sxs-2024.0.15.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+sxs-2024.0.15.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2024.0.15.dist-info/RECORD,,