sxs 2024.0.10__py3-none-any.whl → 2024.0.12__py3-none-any.whl

sxs/__init__.py

@@ -43,8 +43,9 @@ astronomical_unit = 149_597_870_700.0  # m
 parsec_in_meters = 3.0856775814913672789139379577965e16  # m
 
 # The value of the solar mass parameter G*M_sun is known to higher accuracy than either of its
-# factors.  The value here is taken from the publication "2021 Selected Astronomical Constants",
-# which can be found at <https://asa.hmnao.com/static/files/2021/Astronomical_Constants_2021.pdf>.
+# factors.  The value here is taken from the IAU Division I Working Group's publication on
+# "Numerical Standards for Fundamental Astronomy"
+# <https://iau-a3.gitlab.io/NSFA/NSFA_cbe.html#GMS2012>.
 # In the TDB (Barycentric Dynamical Time) time scale — which seems to be the more relevant one and
 # looks like the more standard one for LIGO — we have
 solar_mass_parameter = 1.32712440041e20  # m^3/s^2

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2024.0.10"
+__version__ = "2024.0.12"

sxs/simulations/local.py

@@ -0,0 +1,147 @@
+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
+
+def file_upload_allowed(file, directory_listing):
+    """Return True if the file should be uploaded
+    
+    A file should be uploaded if
+        * it is named "metadata.json" or "Horizons.h5"
+        * it is named "Strain_*.json" or "ExtraWaveforms.json" and the corresponding
+          ".h5" file is in the directory listing
+        * it is named "Strain_*.h5" or "ExtraWaveforms.h5" and the corresponding
+          ".json" file is in the directory listing
+    
+    """
+    # Check `file.name` to ignore the directory
+    if file.name in ["metadata.json", "Horizons.h5"]:
+        return True
+    if file.name.startswith("Strain_") or file.name.startswith("ExtraWaveforms"):
+        # Ensure that both `.h5` and `.json` exist for all such files
+        if file.suffix == ".json":
+            return file.with_suffix(".h5") in directory_listing
+        elif file.suffix == ".h5":
+            return file.with_suffix(".json") in directory_listing
+        else:
+            return False
+    return False
+
+
+def files_to_upload(directory, annex_dir="."):
+    """Return a list of files to upload
+
+    The files to upload are those that are in the directory listing
+    and pass the `file_upload_allowed` function.
+
+    """
+    full_directory = annex_dir / Path(directory)
+    files = []
+    for lev in full_directory.resolve().glob("Lev*"):
+        directory_listing = list(lev.iterdir())
+        files.extend([
+            file for file in directory_listing
+            if file_upload_allowed(file, directory_listing)
+        ])
+    return sorted(files, key=lambda x: str(x).lower())
+
+
+def extract_id_from_common_metadata(file, annex_dir):
+    """Extract the SXS ID from a common-metadata.txt file
+    
+    If the ID doesn't exist, return the directory path, relative to
+    the `annex_dir`.
+    """
+    file = Path(file)
+    annex_dir = Path(annex_dir)
+    key = str(file.resolve().parent.relative_to(annex_dir.resolve()))
+    with file.open("r") as f:
+        for line in f.readlines():
+            line = line.strip()
+            if "alternative-names" in line:
+                if (m := sxs_identifier_re.search(line)):
+                    key = m["sxs_identifier"]
+                    break
+    return key
+
+
+def local_simulations(annex_dir):
+    """
+    Walk the annex directory to find and process all simulations
+
+    For each `common-metadata.txt` file found:
+        - Ensures that at least one directory starting with "Lev"
+          exists; if not, the process is skipped.
+        - Defines a key for the metadata, which is either:
+            - The SXS ID contained in that file's "alternative-names"
+              field, if present.
+            - The directory path relative to `annex_dir`.
+        - Chooses the highest "Lev" directory and extracts the
+          metadata.
+        - Finds all files to upload in the directory; if none are
+          found, the process is skipped.
+        - Adds the "files" dictionary to the metadata, pointing to
+          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.
+    """
+    from os import walk
+
+    simulations = {}
+    annex_dir = Path(annex_dir).resolve()
+
+    # 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)
+
+        # Ignore hidden directories
+        if dirpath.name.startswith("."):
+            dirnames[:] = []
+            continue
+
+        if "common-metadata.txt" in filenames:
+            if not any(d.startswith("Lev") for d in dirnames):
+                continue
+
+            key = extract_id_from_common_metadata(dirpath / "common-metadata.txt", annex_dir)
+
+            # Find the highest Lev directory and extract the metadata
+            highest_lev = sorted(
+                [d for d in dirnames if d.startswith("Lev")]
+            )[-1]
+            metadata = Metadata.load(dirpath / highest_lev / "metadata")
+
+            metadata["files"] = {
+                p2i(file.relative_to(dirpath)): {"link": str(file)}
+                for file in files_to_upload(dirpath, annex_dir)
+            }
+
+            simulations[key] = metadata
+
+            dirnames[:] = []  # Don't keep looking for common-metadata.txt files under this directory
+
+    return simulations
+
+
+def write_local_simulations(annex_dir):
+    """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:
+        None
+    """
+    from json import dump
+
+    simulations = local_simulations(annex_dir)
+    with open(sxs_directory("cache") / "local_simulations.json", "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-2024.0.10.dist-info → sxs-2024.0.12.dist-info}/METADATA

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

@@ -1,5 +1,5 @@
-sxs/__init__.py,sha256=51_F8xiD6cdE2kIq9dPyHxNQVsp4oCvtR1wQQQ0VS2A,2577
-sxs/__version__.py,sha256=HO2uZQyvoVBeimxjf5paV_MvgXvaiQQkNFP85H526HY,26
+sxs/__init__.py,sha256=cZJ3qp5EjO2QSJaajRVJX4xYBvReEHBoG1lNeFpBJfU,2579
+sxs/__version__.py,sha256=tkOiDn4eJJ71UmES82yWpR2x09xcmvhOCR3F4rVLbow,26
 sxs/handlers.py,sha256=zm1NQTeyM2idXzcmL24YXjnRVn2PBEa72LQQUUMHgOM,16667
 sxs/juliapkg.json,sha256=higH1UDu30K_PN6-o7lAz0j1xjgYEiCCYBAc-Iaw1Iw,178
 sxs/time_series.py,sha256=OKaLg8tFyrtKcef7900ri-a0C6A8wKxA68KovZXvH6I,41081
@@ -18,7 +18,8 @@ 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/simulation.py,sha256=BSqUCoiptbY_obC0fKrTACfwiFnvgHRibHLEx-H4_Rk,33915
+sxs/simulations/local.py,sha256=pibf9uED--w6OMI6tPq8aKmI1y89CIQph40Zmq4yjNE,5127
+sxs/simulations/simulation.py,sha256=WgxvZexjBH9fwd5qKID7YwvA1wglHerXwS_VQT1LlkY,33915
 sxs/simulations/simulations.py,sha256=s20HdjEIcoG3vsgJcC4CwjfhICVwKWNABOYYucPEfSs,17108
 sxs/utilities/__init__.py,sha256=KTtsBKblP02t20anSzV_7tucRUw_bFObY5my5ZuJEBU,4793
 sxs/utilities/bitwise.py,sha256=G9ZNYgwDQRhq5wbDf-p2HcUqkEP_IRDiQoXW4KyU17k,13205
@@ -78,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.10.dist-info/METADATA,sha256=5ZHOyiVzpdCcK67xfRxisfJKSbMf1XPEUkveai25Qk8,9245
-sxs-2024.0.10.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-sxs-2024.0.10.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2024.0.10.dist-info/RECORD,,
+sxs-2024.0.12.dist-info/METADATA,sha256=1M3pphEcN6RIcbW43ySVMPKwGKXWZO75ORnOKle5YsM,9245
+sxs-2024.0.12.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+sxs-2024.0.12.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2024.0.12.dist-info/RECORD,,