sxs 2024.0.12__tar.gz → 2024.0.14__tar.gz

{sxs-2024.0.12 → 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.12
-date-released: 2024-10-04
+version: 2024.0.14
+date-released: 2024-10-09

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2024.0.12
+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.12 → sxs-2024.0.14}/sxs/__init__.py

@@ -29,7 +29,7 @@ from .waveforms import rotating_paired_xor_multishuffle_bzip2 as rpxmb
 from .waveforms import rotating_paired_diff_multishuffle_bzip2 as rpdmb
 from .waveforms import spectre_cce_v1
 from . import catalog, metadata, horizons, waveforms, zenodo, caltechdata
-from .simulations import Simulation, Simulations
+from .simulations import Simulation, Simulations, write_local_simulations, local_simulations
 from .handlers import load, load_via_sxs_id, loadcontext, load_lvc
 
 # The speed of light is, of course, defined to be exactly

sxs-2024.0.14/sxs/__version__.py

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

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

@@ -283,6 +283,12 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
         elif location == "simulations":
             return Simulations.load(download=download)
 
+        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.12 → sxs-2024.0.14}/sxs/simulations/__init__.py

@@ -1,2 +1,3 @@
 from .simulation import Simulation
 from .simulations import Simulations
+from .local import write_local_simulations, local_simulations

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

@@ -84,13 +84,15 @@ def local_simulations(annex_dir):
           each file that would be uploaded if the simulation were
           published.
 
-    Args:
-        annex_dir (str or Path): The path to the annex directory to be
-        processed.
-
-    Returns:
-        dict: A dictionary containing the processed simulations
-        metadata.
+    Parameters
+    ----------
+    annex_dir : (str or Path)
+        The path to the annex directory to be processed.
+
+    Returns
+    -------
+    dict :
+        A dictionary containing the processed metadata.
     """
     from os import walk
 
@@ -117,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)}
@@ -130,18 +133,33 @@ def local_simulations(annex_dir):
     return simulations
 
 
-def write_local_simulations(annex_dir):
+def write_local_simulations(annex_dir, output_file=None):
     """Write the local simulations to a file for use when loading `Simulations`
 
-    Args:
-        annex_dir (str or Path): The path to the annex directory to be
-        processed.
-
-    Returns:
+    Parameters
+    ----------
+    annex_dir : (str or Path)
+        The path to the annex directory to be processed.
+    output_file : (str or Path, optional)
+        The path to the file to be written.  By default, the file is
+        written to `sxs_directory("cache") / "local_simulations.json"`.
+        N.B.: If you specify a different file, `sxs.load` will not
+        automatically find it.
+
+    Returns
+    -------
         None
     """
     from json import dump
 
+    # Process the annex directory to find all simulations
     simulations = local_simulations(annex_dir)
-    with open(sxs_directory("cache") / "local_simulations.json", "w") as f:
+
+    # Write the simulations to file
+    if output_file is None:
+        output_file = sxs_directory("cache") / "local_simulations.json"
+    else:
+        output_file = Path(output_file)
+    output_file.parent.mkdir(parents=True, exist_ok=True)
+    with output_file.open("w") as f:
         dump(simulations, f, indent=2, separators=(",", ": "), ensure_ascii=True)

{sxs-2024.0.12 → 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):
@@ -64,6 +116,62 @@ class Simulations(collections.OrderedDict):
             )
             return datetime.min.replace(tzinfo=timezone.utc)
         return remote_timestamp
+    
+    @classmethod
+    def local(cls, directory=None, *, download=None):
+        """Load the local catalog of SXS simulations
+        
+        This function loads the standard public catalog, but also
+        includes any local simulations found in the given directory.
+        If no directory is provided, it will look for the local
+        simulations file in the sxs cache directory.
+
+        Parameters
+        ----------
+        directory : {None, str, Path}, optional
+            A directory containing subdirectories of SXS simulations.
+            See `sxs.local_simulations` for details about what is
+            expected in this directory.  If None (the default), it
+            will look for the local simulations file in the sxs cache
+            directory.
+        download : {None, bool}, optional
+            Passed to `Simulations.load` when loading the public set
+            of simulations.
+
+        See Also
+        --------
+        sxs.local_simulations : Search for local simulations
+        sxs.write_local_simulations : Write local simulations to a file
+        
+        """
+        import json
+        from .local import write_local_simulations
+        from .. import sxs_directory
+
+        local_path = sxs_directory("cache") / "local_simulations.json"
+        if directory is not None:
+            write_local_simulations(directory)
+        if not local_path.exists():
+            if directory is not None:
+                raise ValueError(f"Writing local simulations for {directory=} failed")
+            else:
+                raise ValueError(
+                    f"Local simulations file not found, but no `directory` was provided.\n"
+                    + "If called from `sxs.load`, just pass the name of the directory."
+                )
+        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()
@@ -266,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),
@@ -338,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.12/sxs/__version__.py

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