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

sxs/__version__.py

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

sxs/simulations/local.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 from .. import sxs_id, Metadata, sxs_directory
 from ..utilities import sxs_identifier_re
-from ..zenodo import path_to_invenio as p2i
+from ..zenodo import path_to_invenio
 
 def file_upload_allowed(file, directory_listing):
     """Return True if the file should be uploaded
@@ -65,7 +65,7 @@ def extract_id_from_common_metadata(file, annex_dir):
     return key
 
 
-def local_simulations(annex_dir):
+def local_simulations(annex_dir, compute_md5=False):
     """
     Walk the annex directory to find and process all simulations
 
@@ -88,6 +88,9 @@ def local_simulations(annex_dir):
     ----------
     annex_dir : (str or Path)
         The path to the annex directory to be processed.
+    compute_md5 : bool, optional
+        Whether to compute the MD5 hash of each file.  Default is
+        False.
 
     Returns
     -------
@@ -95,6 +98,7 @@ def local_simulations(annex_dir):
         A dictionary containing the processed metadata.
     """
     from os import walk
+    from ..utilities import md5checksum
 
     simulations = {}
     annex_dir = Path(annex_dir).resolve()
@@ -121,8 +125,14 @@ def local_simulations(annex_dir):
             metadata = Metadata.load(dirpath / highest_lev / "metadata")
             metadata = metadata.add_standard_parameters()
 
+            metadata["directory"] = str(dirpath.relative_to(annex_dir))
+
             metadata["files"] = {
-                p2i(file.relative_to(dirpath)): {"link": str(file)}
+                path_to_invenio(file.relative_to(dirpath)): {
+                    "link": str(file),
+                    "size": file.stat().st_size,
+                    "checksum": md5checksum(file) if compute_md5 else "",
+                }
                 for file in files_to_upload(dirpath, annex_dir)
             }
 
@@ -136,6 +146,10 @@ def 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`
 
+    This function calls `local_simulations` to obtain the dictionary,
+    but also writes the dictionary to a JSON file.
+
+
     Parameters
     ----------
     annex_dir : (str or Path)
@@ -148,7 +162,8 @@ def write_local_simulations(annex_dir, output_file=None):
 
     Returns
     -------
-        None
+    dict :
+        A dictionary containing the processed metadata.
     """
     from json import dump
 
@@ -163,3 +178,5 @@ def write_local_simulations(annex_dir, output_file=None):
     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-2024.0.32.dist-info → sxs-2024.0.33.dist-info}/METADATA

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

@@ -1,5 +1,5 @@
 sxs/__init__.py,sha256=hbydsXWR88sFiKExPJ1NHWGEvWRbbJBjSc1irSMYKgY,2623
-sxs/__version__.py,sha256=A2U1DfZggmyzaeMHvwltT9u7oeSoPzDzUi7hPfVR7rk,26
+sxs/__version__.py,sha256=1aAfFJkJXDhyQxvB5A7JGzfK5gLev3uJrAgjXgoxXkA,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=CEu8PzumNB1-JA05M4tYSW_UZVrldKzOB5T_I3pFWls,5789
+sxs/simulations/local.py,sha256=51ULBmrodAPZXv2_qpLeEWKIR9zwPGR-zPt7XG8Vcqs,6403
 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.32.dist-info/METADATA,sha256=1Gxiy4xo21iZ4foUf5HTSuSnTO1rXFEWJ-WeVPzNLbw,9253
-sxs-2024.0.32.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sxs-2024.0.32.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2024.0.32.dist-info/RECORD,,
+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,,