sxs 2024.0.42__py3-none-any.whl → 2024.0.44__py3-none-any.whl

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2024.0.42"
+__version__ = "2024.0.44"

sxs/handlers.py

@@ -284,14 +284,20 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
             return Simulations.load(
                 download=download,
                 local=kwargs.get("local", False),
-                annex_dir=kwargs.get("annex_dir", None)
+                annex_dir=kwargs.get("annex_dir", None),
+                output_file=kwargs.get("output_file", None),
+                compute_md5=kwargs.get("compute_md5", False),
+                show_progress=kwargs.get("show_progress", False)
             )
 
         elif location == "dataframe":
             return Simulations.load(
                 download=download,
                 local=kwargs.get("local", False),
-                annex_dir=kwargs.get("annex_dir", None)
+                annex_dir=kwargs.get("annex_dir", None),
+                output_file=kwargs.get("output_file", None),
+                compute_md5=kwargs.get("compute_md5", False),
+                show_progress=kwargs.get("show_progress", False)
             ).dataframe
 
         elif sxs_id_version_lev_exact_re.match(location):

sxs/simulations/local.py

@@ -215,12 +215,13 @@ def write_local_simulations(annex_dir, output_file=None, compute_md5=False, show
     simulations = local_simulations(annex_dir, compute_md5=compute_md5, show_progress=show_progress)
 
     # 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)
+    if output_file is not False:  # Test literal identity to allow `None`
+        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)
 
     return simulations

sxs/simulations/simulations.py

@@ -173,7 +173,7 @@ class Simulations(collections.OrderedDict):
         return remote_timestamp
     
     @classmethod
-    def local(cls, directory=None, *, download=None):
+    def local(cls, directory=None, *, download=None, output_file=None, compute_md5=False, show_progress=False):
         """Load the local catalog of SXS simulations
         
         This function loads the standard public catalog, but also
@@ -192,30 +192,47 @@ class Simulations(collections.OrderedDict):
         download : {None, bool}, optional
             Passed to `Simulations.load` when loading the public set
             of simulations.
+        output_file : {None, str, Path}, optional
+            If `directory` is not None, this will be passed to
+            `sxs.write_local_simulations`.
+        compute_md5 : bool, optional
+            If `directory` is not None, this will be passed to
+            `sxs.local_simulations`.
+        show_progress : bool, optional
+            If `directory` is not None, this will be passed to
+            `sxs.local_simulations`.
 
         See Also
         --------
         sxs.local_simulations : Search for local simulations
-        sxs.write_local_simulations : Write local simulations to a file
+        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)
+            local_path = output_file
+            local_simulations = write_local_simulations(
+                directory,
+                output_file=output_file,
+                compute_md5=compute_md5,
+                show_progress=show_progress
+            )
+        else:
+            local_path = sxs_directory("cache") / "local_simulations.json"
+            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"]
@@ -229,7 +246,7 @@ class Simulations(collections.OrderedDict):
         return simulations
 
     @classmethod
-    def load(cls, download=None, *, local=False, annex_dir=None):
+    def load(cls, download=None, *, local=False, annex_dir=None, output_file=None, compute_md5=False, show_progress=False):
         """Load the catalog of SXS simulations
 
         Note that — unlike most SXS data files — the simulations file
@@ -263,6 +280,15 @@ class Simulations(collections.OrderedDict):
             If provided and `local=True`, this function will load
             local simulations from the given directory.  This is
             equivalent to calling `Simulations.local(directory)`.
+        output_file : {None, str, Path}, optional
+            If `annex_dir` is not None, this will be passed to
+            `sxs.write_local_simulations`.
+        compute_md5 : bool, optional
+            If `annex_dir` is not None, this will be passed to
+            `sxs.simulations.local_simulations`.
+        show_progress : bool, optional
+            If `annex_dir` is not None, this will be passed to
+            `sxs.simulations.local_simulations`.
 
         See Also
         --------
@@ -280,7 +306,13 @@ class Simulations(collections.OrderedDict):
             return cls._simulations
 
         if local or annex_dir is not None:
-            cls._simulations = cls.local(annex_dir, download=download)
+            cls._simulations = cls.local(
+                annex_dir,
+                download=download,
+                output_file=output_file,
+                compute_md5=compute_md5,
+                show_progress=show_progress
+            )
             return cls._simulations
 
         progress = read_config("download_progress", True)

{sxs-2024.0.42.dist-info → sxs-2024.0.44.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sxs
-Version: 2024.0.42
+Version: 2024.0.44
 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.42.dist-info → sxs-2024.0.44.dist-info}/RECORD

@@ -1,6 +1,6 @@
 sxs/__init__.py,sha256=hbydsXWR88sFiKExPJ1NHWGEvWRbbJBjSc1irSMYKgY,2623
-sxs/__version__.py,sha256=ottZ66pDpZJXsL9jK_3ggKCu87Pdr1LjtjI0B6EzUkI,26
-sxs/handlers.py,sha256=Nc1_aDKm_wDHg2cITI_ljbqU4VRWpwQ7fdgy3c1XcE8,17531
+sxs/__version__.py,sha256=VkT9SDxmqx5TY0atB540yqsbLb0xRC7qK2gKY9KwH-8,26
+sxs/handlers.py,sha256=Lu3rY7jHn3jEwnUDHVZgZIv1-3AAPAXD61baZAO49a8,17909
 sxs/juliapkg.json,sha256=-baaa3Za_KBmmiGjlh2YYLWmvUvZl6GaKKXwNI4S7qU,178
 sxs/time_series.py,sha256=OKaLg8tFyrtKcef7900ri-a0C6A8wKxA68KovZXvH6I,41081
 sxs/caltechdata/__init__.py,sha256=pvyc2Djch4DA6t06op-0NSTegrMSywzNi7Z3W_91-Cg,14670
@@ -19,9 +19,9 @@ sxs/metadata/__init__.py,sha256=jz0A3sBYQoNVZ5sdHv6LgI6y4kP2051-esCR62xt6bM,184
 sxs/metadata/metadata.py,sha256=vqzNufg46BrbFAuvDF55JvrQc0ZIBxSG4eH2awv5PDs,28610
 sxs/metadata/metric.py,sha256=W_PMNmsJ2qBjIeAll4TgUz79-SZkiBTswTfK4gKWrPU,6785
 sxs/simulations/__init__.py,sha256=GrZym0PHTULDg_hyFmISNzDfqVLz_hQo-djbgecZs54,134
-sxs/simulations/local.py,sha256=kyFvlw9CywlyBy0H2GiSgOp4M7Uq31Db5LIdd2do43M,8242
+sxs/simulations/local.py,sha256=nfca2cG3LWNC8Jc-i79BZmKdwPfhPgPKja-wXg_qEKw,8344
 sxs/simulations/simulation.py,sha256=lVA2aSRy4-V1-1bFE74zIN8Tpvf7QDtn9n7xmR7oqcU,37579
-sxs/simulations/simulations.py,sha256=xP1ljseDSkfs6_u25-DnSNlFQtQexiP25Kwtm7nWdsE,23910
+sxs/simulations/simulations.py,sha256=5OYQez3BXtg8zbCe85MlSqYtAKv4UqXt7iRfLiPAWxw,25367
 sxs/utilities/__init__.py,sha256=WSStlqljfgQheMxHGfuofSc5LdmASGvO3FNO3f_zaT0,4806
 sxs/utilities/bitwise.py,sha256=G9ZNYgwDQRhq5wbDf-p2HcUqkEP_IRDiQoXW4KyU17k,13205
 sxs/utilities/dicts.py,sha256=CCpm3upG_9SRj9gjawukSUfaJ5asF-XRG2ausEXhYyg,695
@@ -82,7 +82,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.42.dist-info/METADATA,sha256=46jHQPJbcRe8xSeA1qul7zXbf0_11yfOJO5l1v0Dd2s,9253
-sxs-2024.0.42.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sxs-2024.0.42.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2024.0.42.dist-info/RECORD,,
+sxs-2024.0.44.dist-info/METADATA,sha256=T73d-Ee58PLzfKUG8mM4fBxZ_r3C3mFQAB-oP-fS8rk,9253
+sxs-2024.0.44.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sxs-2024.0.44.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2024.0.44.dist-info/RECORD,,