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

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/__version__.py

@@ -1 +1 @@
-__version__ = "2024.0.11"
+__version__ = "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/simulations/__init__.py

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

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/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/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.dist-info → sxs-2024.0.13.dist-info}/METADATA

@@ -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.dist-info → sxs-2024.0.13.dist-info}/RECORD

@@ -1,6 +1,6 @@
-sxs/__init__.py,sha256=cZJ3qp5EjO2QSJaajRVJX4xYBvReEHBoG1lNeFpBJfU,2579
-sxs/__version__.py,sha256=Xd7nz7DPZis9Vq-2REnlFOQdwBBtH_mJhRJ6B6Q_dEA,26
-sxs/handlers.py,sha256=zm1NQTeyM2idXzcmL24YXjnRVn2PBEa72LQQUUMHgOM,16667
+sxs/__init__.py,sha256=hbydsXWR88sFiKExPJ1NHWGEvWRbbJBjSc1irSMYKgY,2623
+sxs/__version__.py,sha256=ccSsvMKSEb0DDrHig0GNWueoK8ceho4S2fY9o4nd_po,26
+sxs/handlers.py,sha256=bnQ1pH9EXZV_1iW9zf_WA61CfsavFjbcA0gmtoY5KWY,16770
 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
@@ -17,10 +17,10 @@ sxs/julia/GWFrames.py,sha256=47H9Ugff7ldGBujiUTcADT3b4MSxUtqmajvSApI91WA,2892
 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=sl-sDI5N2A03lAfzMig8Jm_Beri_v65qjlIOeGGX9XM,72
-sxs/simulations/local.py,sha256=pibf9uED--w6OMI6tPq8aKmI1y89CIQph40Zmq4yjNE,5127
-sxs/simulations/simulation.py,sha256=BSqUCoiptbY_obC0fKrTACfwiFnvgHRibHLEx-H4_Rk,33915
-sxs/simulations/simulations.py,sha256=s20HdjEIcoG3vsgJcC4CwjfhICVwKWNABOYYucPEfSs,17108
+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/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.11.dist-info/METADATA,sha256=L0BUBgb5iCjiD0YZYsnYYXQpcjQZy9gP9GB6sOcY2EE,9245
-sxs-2024.0.11.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-sxs-2024.0.11.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2024.0.11.dist-info/RECORD,,
+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,,