sxs 2024.0.33__py3-none-any.whl → 2024.0.34__py3-none-any.whl

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2024.0.33"
+__version__ = "2024.0.34"

sxs/simulations/local.py

@@ -65,7 +65,7 @@ def extract_id_from_common_metadata(file, annex_dir):
     return key
 
 
-def local_simulations(annex_dir, compute_md5=False):
+def local_simulations(annex_dir, compute_md5=False, show_progress=False):
     """
     Walk the annex directory to find and process all simulations
 
@@ -91,6 +91,8 @@ def local_simulations(annex_dir, compute_md5=False):
     compute_md5 : bool, optional
         Whether to compute the MD5 hash of each file.  Default is
         False.
+    show_progress : bool, optional
+        Whether to show a progress bar.  Default is False.
 
     Returns
     -------
@@ -99,10 +101,24 @@ def local_simulations(annex_dir, compute_md5=False):
     """
     from os import walk
     from ..utilities import md5checksum
+    from tqdm import tqdm
 
     simulations = {}
     annex_dir = Path(annex_dir).resolve()
 
+    if show_progress:  # Count the number of common-metadata.txt files
+        num_files = 0
+        for dirpath, dirnames, filenames in walk(annex_dir, topdown=True):
+            if Path(dirpath).name.startswith("."):
+                dirnames[:] = []
+                continue
+            if "common-metadata.txt" in filenames:
+                if not any(d.startswith("Lev") for d in dirnames):
+                    continue
+                num_files += 1
+                dirnames[:] = []
+        progress_bar = tqdm(total=num_files, desc="Processing simulations")
+
     # The `walk` method can be made *much* faster than the `glob` method
     for dirpath, dirnames, filenames in walk(annex_dir, topdown=True):
         dirpath = Path(dirpath)
@@ -116,6 +132,9 @@ def local_simulations(annex_dir, compute_md5=False):
             if not any(d.startswith("Lev") for d in dirnames):
                 continue
 
+            if show_progress:
+                progress_bar.update(1)
+
             key = extract_id_from_common_metadata(dirpath / "common-metadata.txt", annex_dir)
 
             # Find the highest Lev directory and extract the metadata
@@ -143,13 +162,12 @@ def local_simulations(annex_dir, compute_md5=False):
     return simulations
 
 
-def write_local_simulations(annex_dir, output_file=None):
+def write_local_simulations(annex_dir, output_file=None, compute_md5=False, show_progress=False):
     """Write the local simulations to a file for use when loading `Simulations`
 
     This function calls `local_simulations` to obtain the dictionary,
     but also writes the dictionary to a JSON file.
 
-
     Parameters
     ----------
     annex_dir : (str or Path)
@@ -159,6 +177,11 @@ def write_local_simulations(annex_dir, output_file=None):
         written to `sxs_directory("cache") / "local_simulations.json"`.
         N.B.: If you specify a different file, `sxs.load` will not
         automatically find it.
+    compute_md5 : bool, optional
+        Whether to compute the MD5 hash of each file.  Default is
+        False.
+    show_progress : bool, optional
+        Whether to show a progress bar.  Default is False.
 
     Returns
     -------
@@ -168,7 +191,7 @@ def write_local_simulations(annex_dir, output_file=None):
     from json import dump
 
     # Process the annex directory to find all simulations
-    simulations = local_simulations(annex_dir)
+    simulations = local_simulations(annex_dir, compute_md5=compute_md5, show_progress=show_progress)
 
     # Write the simulations to file
     if output_file is None:

{sxs-2024.0.33.dist-info → sxs-2024.0.34.dist-info}/METADATA

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

@@ -1,5 +1,5 @@
 sxs/__init__.py,sha256=hbydsXWR88sFiKExPJ1NHWGEvWRbbJBjSc1irSMYKgY,2623
-sxs/__version__.py,sha256=1aAfFJkJXDhyQxvB5A7JGzfK5gLev3uJrAgjXgoxXkA,26
+sxs/__version__.py,sha256=_cjLIU-5BZ9McQVaMqAHxQtb0C2QCB3z4_ZhWhK4Bzs,26
 sxs/handlers.py,sha256=Nc1_aDKm_wDHg2cITI_ljbqU4VRWpwQ7fdgy3c1XcE8,17531
 sxs/juliapkg.json,sha256=-baaa3Za_KBmmiGjlh2YYLWmvUvZl6GaKKXwNI4S7qU,178
 sxs/time_series.py,sha256=OKaLg8tFyrtKcef7900ri-a0C6A8wKxA68KovZXvH6I,41081
@@ -18,7 +18,7 @@ sxs/julia/__init__.py,sha256=uSLP_xfU-GZG7IO5vs0TEkCR4LH8aBYMF-852wDY3kI,3490
 sxs/metadata/__init__.py,sha256=KCvJ9Cf1WhIZp-z28UzarKcmUAzV2BOv2gqKiorILjo,149
 sxs/metadata/metadata.py,sha256=EEax1WTKL4G5U__wHefbBX0l4vtIHTcYFnHwziGkVhM,28348
 sxs/simulations/__init__.py,sha256=GrZym0PHTULDg_hyFmISNzDfqVLz_hQo-djbgecZs54,134
-sxs/simulations/local.py,sha256=51ULBmrodAPZXv2_qpLeEWKIR9zwPGR-zPt7XG8Vcqs,6403
+sxs/simulations/local.py,sha256=A2r2tzD8ZMKfuKPlTuKYu60nRkxnnohfeFKNoZVfLHg,7480
 sxs/simulations/simulation.py,sha256=OqQh6xq-s_JoQI6e2XA5j194L0DT3HGYIW8ZZiurZ2Y,34631
 sxs/simulations/simulations.py,sha256=ATxrcihvblGgRHdR7vIMg5eKghN5Jo6U0CafTro4wYA,24827
 sxs/utilities/__init__.py,sha256=WSStlqljfgQheMxHGfuofSc5LdmASGvO3FNO3f_zaT0,4806
@@ -80,7 +80,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.33.dist-info/METADATA,sha256=agwAnGwVuDDEI52_MS-8kMT1aX7c6Ps-E5SWq0l6kYE,9253
-sxs-2024.0.33.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sxs-2024.0.33.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2024.0.33.dist-info/RECORD,,
+sxs-2024.0.34.dist-info/METADATA,sha256=6YToh2veoD4_MPLzTwoiXOy0xYueasdvjDGhjTRbHVc,9253
+sxs-2024.0.34.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sxs-2024.0.34.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2024.0.34.dist-info/RECORD,,