sxs 2024.0.14__py3-none-any.whl → 2024.0.16__py3-none-any.whl

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2024.0.14"
+__version__ = "2024.0.16"

sxs/handlers.py

@@ -281,13 +281,18 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
             return Catalog.load(download=download)
 
         elif location == "simulations":
-            return Simulations.load(download=download)
-
-        elif location == "local_simulations":
-            return Simulations.local(download=download)
+            return Simulations.load(
+                download=download,
+                local=kwargs.get("local", False),
+                annex_dir=kwargs.get("annex_dir", None)
+            )
 
         elif location == "dataframe":
-            return Simulations.load(download=download).dataframe
+            return Simulations.load(
+                download=download,
+                local=kwargs.get("local", False),
+                annex_dir=kwargs.get("annex_dir", None)
+            ).dataframe
 
         elif sxs_id_version_lev_exact_re.match(location):
             return Simulation(location, download=download, cache=cache, progress=progress, **kwargs)

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

@@ -174,31 +174,45 @@ class Simulations(collections.OrderedDict):
         return simulations
 
     @classmethod
-    @functools.lru_cache()
-    def load(cls, download=None):
+    def load(cls, download=None, *, local=False, annex_dir=None):
         """Load the catalog of SXS simulations
 
-        Note that — unlike most SXS data files — the simulations file is updated
-        frequently.  As a result, this function — unlike the loading functions for most
-        SXS data files — will download the simulations by default each time it is called.
-        However, also note that this function is itself cached, meaning that the same
-        dict will be returned on each call in a given python session.  If you want to
-        avoid that behavior, use `Simulations.reload`.
+        Note that — unlike most SXS data files — the simulations file
+        is updated frequently.  As a result, this function — unlike
+        the loading functions for most SXS data files — will download
+        the simulations by default each time it is called.  However,
+        also note that this function is itself cached, meaning that
+        the same dict will be returned on each call in a given python
+        session.  If you want to avoid that behavior, use
+        `Simulations.reload`.
 
         Parameters
         ----------
         download : {None, bool}, optional
-            If False, this function will look for the simulations in the sxs cache and
-            raise an error if it is not found.  If True, this function will download
-            the simulations and raise an error if the download fails.  If None (the
-            default), it will try to download the file, warn but fall back to the cache
-            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.
+            If False, this function will look for the simulations in
+            the sxs cache and raise an error if it is not found.  If
+            True, this function will download the simulations and
+            raise an error if the download fails.  If None (the
+            default), it will try to download the file, warn but fall
+            back to the cache 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`.
+        annex_dir : {None, str, Path}, optional
+            If provided and `local=True`, this function will load
+            local simulations from the given directory.  This is
+            equivalent to calling `Simulations.local(directory)`.
 
         See Also
         --------
-        sxs.sxs_directory : Locate cache directory
-        Simulations.reload : Avoid caching the result of this function
+        sxs.sxs_directory : Locate cache directory Simulations.reload
+        : Avoid caching the result of this function
 
         """
         from datetime import datetime, timezone
@@ -207,6 +221,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 or annex_dir is not None:
+            cls._simulations = cls.local(annex_dir, download=download)
+            return cls._simulations
+
         progress = read_config("download_progress", True)
 
         remote_timestamp = cls.remote_timestamp(download is not False)  # Test for literal `False`
@@ -268,6 +289,8 @@ class Simulations(collections.OrderedDict):
 
         sims = cls(simulations)
         sims.__file__ = str(cache_path)
+
+        cls._simulations = sims
         return sims
 
     @classmethod

{sxs-2024.0.14.dist-info → sxs-2024.0.16.dist-info}/METADATA

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

@@ -1,6 +1,6 @@
 sxs/__init__.py,sha256=hbydsXWR88sFiKExPJ1NHWGEvWRbbJBjSc1irSMYKgY,2623
-sxs/__version__.py,sha256=vdCUhZemn99E8FoC13JF2FXz3SWQuB-IUxT4uez_vj8,26
-sxs/handlers.py,sha256=B3mCX7sPtnyYpkzuDCUrpHL4pmHDo9I7UjaHAIJ2s5A,16874
+sxs/__version__.py,sha256=Y9aaAFW7eTBLUBcBXdQZd1KNgLbPAplcEe8kdPULxS4,26
+sxs/handlers.py,sha256=7x6LeBR7nYwq83ObL9KS9UsZ1qxd7yvOsjmQarhUHro,17045
 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
@@ -19,8 +19,8 @@ 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=CEu8PzumNB1-JA05M4tYSW_UZVrldKzOB5T_I3pFWls,5789
-sxs/simulations/simulation.py,sha256=WgxvZexjBH9fwd5qKID7YwvA1wglHerXwS_VQT1LlkY,33915
-sxs/simulations/simulations.py,sha256=orsogZOyktC5EiY2U4HzHlF_evMKT5du7t6s6jGphSk,21132
+sxs/simulations/simulation.py,sha256=UN7cQ8y1Ccr3TPI8TyMAr9hvzQuM8NcitqXJJ0IXNPs,34110
+sxs/simulations/simulations.py,sha256=8R3EVfq0OLT2wAE5vjLbx4gCte79M7depb-SB6PLSRU,21971
 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.14.dist-info/METADATA,sha256=KttQT3Xa2eCymq08LJ5S0oXqQj_S1f8W2gfDNwJgqGc,9245
-sxs-2024.0.14.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-sxs-2024.0.14.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2024.0.14.dist-info/RECORD,,
+sxs-2024.0.16.dist-info/METADATA,sha256=rIJB0m7egc53y17106x0JYCZlwo1PmDcT-UVwRf3TDI,9245
+sxs-2024.0.16.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+sxs-2024.0.16.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2024.0.16.dist-info/RECORD,,