sxs 2024.0.11__tar.gz → 2024.0.13__tar.gz

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2024.0.11
+Version: 2024.0.13
 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/
@@ -44,7 +44,7 @@ Requires-Dist: pandas>=1.1.2
 Requires-Dist: pytz>=2020.1
 Requires-Dist: quaternionic>=1.0
 Requires-Dist: requests>=2.24.0
-Requires-Dist: scipy>=1.0
+Requires-Dist: scipy>=1.7
 Requires-Dist: spherical>=1.0
 Requires-Dist: tqdm>=4.63.1
 Requires-Dist: urllib3>=1.25.10

{sxs-2024.0.11 → sxs-2024.0.13}/pyproject.toml

@@ -19,7 +19,7 @@ classifiers = [
 ]
 dependencies = [
   "numpy >=1.20",
-  "scipy >=1.0",
+  "scipy >=1.7",
   "numba >=0.55; implementation_name == 'cpython'",
   "quaternionic >=1.0",
   "spherical >=1.0",

{sxs-2024.0.11 → sxs-2024.0.13}/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.13/sxs/__version__.py

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

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

@@ -283,6 +283,9 @@ 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 sxs_id_version_lev_exact_re.match(location):
             return Simulation(location, download=download, cache=cache, progress=progress, **kwargs)
 

{sxs-2024.0.11 → sxs-2024.0.13}/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.11 → sxs-2024.0.13}/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
 
@@ -130,18 +132,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.11 → sxs-2024.0.13}/sxs/simulations/simulation.py

@@ -423,7 +423,7 @@ class SimulationBase:
         `f_ref`.
 
         Parameters
-        ==========
+        ----------
         t_ref : float, optional
             The reference time at which the waveform frame is specified.
             This is measured in units of M, and defined relative to the
@@ -456,7 +456,7 @@ class SimulationBase:
             including all modes up to and including this ell value.
 
         Returns
-        =======
+        -------
         times : float array
             Uniformly spaced 1D array of times, in units of M, at which
             the waveform and dynamics quantities are returned.  Aligned

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

@@ -64,6 +64,55 @@ 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)
+        simulations.update(local_simulations)
+        simulations.__file__ = str(local_path)
+        return simulations
 
     @classmethod
     @functools.lru_cache()

sxs-2024.0.11/sxs/__version__.py

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