sxs 2024.0.44__tar.gz → 2025.0.2__tar.gz

{sxs-2024.0.44 → sxs-2025.0.2}/.github/workflows/build.yml

@@ -47,7 +47,7 @@ jobs:
         if: ${{ env.skipping_build_and_test_replicate != 'true' }}
         uses: actions/cache@v4
         with:
-          key: sxs-${{ runner.os }}-1 # Increment this number whenever the cached files should change
+          key: sxs-${{ runner.os }}-2 # Increment this number whenever the cached files should change
           path: |
             ${{ runner.os == 'Linux' && '/home/runner/.cache/sxs' || runner.os == 'Windows' && 'C:\Users\runneradmin\.sxs\cache' || '/Users/runner/.sxs/cache' }}
 

{sxs-2024.0.44 → sxs-2025.0.2}/CITATION.cff

@@ -10,5 +10,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2024.0.44
-date-released: 2025-03-06
+version: 2025.0.2
+date-released: 2025-03-26

{sxs-2024.0.44 → sxs-2025.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sxs
-Version: 2024.0.44
+Version: 2025.0.2
 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/
@@ -46,6 +46,7 @@ Requires-Dist: quaternionic>=1.0.15
 Requires-Dist: requests>=2.24.0
 Requires-Dist: scipy>=1.13
 Requires-Dist: spherical>=1.0.15
+Requires-Dist: sxscatalog>=3.0.0a26
 Requires-Dist: tqdm>=4.63.1
 Requires-Dist: urllib3>=1.25.10
 Provides-Extra: docs

{sxs-2024.0.44 → sxs-2025.0.2}/pyproject.toml

@@ -18,6 +18,7 @@ classifiers = [
   "Topic :: Scientific/Engineering :: Astronomy"
 ]
 dependencies = [
+  "sxscatalog >=3.0.0a26",
   "numpy >=1.25",
   "scipy >=1.13",
   "numba >=0.55; implementation_name == 'cpython'",
@@ -72,6 +73,7 @@ path = "sxs/__version__.py"
 
 [tool.hatch.envs.default]
 dependencies = [
+  "ipython",
   "pytest",
   "pytest-cov",
   "pytest-forked >=1.3.0",

{sxs-2024.0.44 → sxs-2025.0.2}/sxs/__init__.py

@@ -28,7 +28,7 @@ from .waveforms import WaveformModes, WaveformModesDict, to_lvc_conventions #, W
 from .waveforms import rotating_paired_xor_multishuffle_bzip2 as rpxmb
 from .waveforms import rotating_paired_diff_multishuffle_bzip2 as rpdmb
 from .waveforms import spectre_cce_v1
-from . import catalog, metadata, horizons, waveforms, zenodo, caltechdata
+from . import catalog, metadata, horizons, waveforms, zenodo
 from .simulations import Simulation, Simulations, write_local_simulations, local_simulations
 from .handlers import load, load_via_sxs_id, loadcontext, load_lvc
 

sxs-2025.0.2/sxs/__version__.py

@@ -0,0 +1 @@
+__version__ = "2025.0.2"

{sxs-2024.0.44 → sxs-2025.0.2}/sxs/handlers.py

@@ -1,6 +1,7 @@
 """Functions to facilitate generic handling of SXS-format data files"""
 
 import contextlib
+import sxscatalog
 from . import waveforms, doi_url
 
 
@@ -236,7 +237,7 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
     import pathlib
     import urllib.request
     from . import Simulations, Simulation, read_config, sxs_directory, Catalog
-    from .utilities import url, download_file, sxs_path_to_system_path, sxs_id_version_lev_exact_re, lev_path_re
+    from .utilities import url, download_file, sxs_path_to_system_path, sxs_id_version_lev_exact_re, lev_path_re, sxs_identifier_re
 
     # Note: `download` and/or `cache` may still be `None` after this
     if download is None:
@@ -280,25 +281,8 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
         elif location == "catalog":
             return Catalog.load(download=download)
 
-        elif location == "simulations":
-            return Simulations.load(
-                download=download,
-                local=kwargs.get("local", False),
-                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),
-                output_file=kwargs.get("output_file", None),
-                compute_md5=kwargs.get("compute_md5", False),
-                show_progress=kwargs.get("show_progress", False)
-            ).dataframe
+        elif location in ["simulations", "dataframe"]:
+            return sxscatalog.load(location, download=download, **kwargs)
 
         elif sxs_id_version_lev_exact_re.match(location):
             return Simulation(location, download=download, cache=cache, progress=progress, **kwargs)
@@ -310,11 +294,30 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
                 local=kwargs.get("local", False),
                 annex_dir=kwargs.get("annex_dir", None)
             )
+            # If we chop off any "/LevN", and it's in the simulations, load it as a simulation
             if lev_path_re.sub("", location) in simulations:
                 return Simulation(
                     location, download=download, cache=cache, progress=progress, **kwargs
                 )
 
+            # Now we look for a file in `simulations`
+            if sxs_identifier_re.match(location):
+                split_location = sxs_identifier_re.split(location)
+                # Currently we can only handle unversioned SXS ID files
+                if split_location[5] is None:
+                    sxs_id = split_location[1]
+                    file = split_location[-1].lstrip("/").lstrip("\\")
+                    if sxs_id in simulations:
+                        simulation = simulations[sxs_id]
+                        if "files" in simulation:
+                            file_info = simulation["files"][file]
+                            location = file_info["link"]
+                            truepath = truepath or (pathlib.Path(sxs_id) / file)
+                            return load(
+                                location, truepath=truepath,
+                                download=download, cache=cache, progress=progress, **kwargs
+                            )
+
             # Try to find an appropriate SXS file in the catalog
             catalog = Catalog.load(download=download)
             selections = catalog.select_files(location)

sxs-2025.0.2/sxs/metadata/__init__.py

@@ -0,0 +1,2 @@
+"""Interface to SXS metadata files"""
+from sxscatalog.metadata import *

sxs-2025.0.2/sxs/metadata/metadata.py

@@ -0,0 +1,2 @@
+"""Container for metadata of individual simulations"""
+from sxscatalog.metadata.metadata import *

sxs-2025.0.2/sxs/metadata/metric.py

@@ -0,0 +1 @@
+from sxscatalog.metadata.metric import *

sxs-2025.0.2/sxs/simulations/local.py

@@ -0,0 +1 @@
+from sxscatalog.simulations.local import *

{sxs-2024.0.44 → sxs-2025.0.2}/sxs/simulations/simulation.py

@@ -124,9 +124,15 @@ def Simulation(location, *args, **kwargs):
     metadata = Metadata(simulations[simulation_id])
     series = simulations.dataframe.loc[simulation_id]
 
+    # If input_version is not the default, remove "files" from metadata
+    if input_version and input_version != max(metadata.get("DOI_versions", []), default=""):
+        metadata = type(metadata)({
+            key: value for key, value in metadata.items() if key != "files"
+        })
+
     # Check if the specified version exists in the simulation catalog
     if not hasattr(metadata, "DOI_versions"):
-        input_version = "v0.0"
+        input_version = "v0.0"  # A fake version, to signal this sim doesn't know about DOIs
     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}'")
 
@@ -217,10 +223,14 @@ 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 or version == "v0.0":
+    elif 2 <= version_number < 3.0:
         sim = Simulation_v2(
             metadata, series, version, sxs_id_stem, sxs_id, url, files, lev_numbers, output_lev_number, location, *args, **kwargs
         )
+    elif 3 <= version_number < 4.0 or version == "v0.0":
+        sim = Simulation_v3(
+            metadata, series, version, sxs_id_stem, sxs_id, url, files, lev_numbers, output_lev_number, location, *args, **kwargs
+        )
     else:
         raise ValueError(f"Version '{version}' not yet supported")
     sim.__file__ = str(sxs_directory("cache") / sxs_path_to_system_path(sim.sxs_id))
@@ -365,7 +375,7 @@ class SimulationBase:
             dataframe = load("simulations").dataframe
         metadata_metric = metadata_metric or MetadataMetric()
         if drop_deprecated:
-            dataframe = dataframe[~dataframe.deprecated]
+            dataframe = dataframe[~dataframe["deprecated"]]
         return dataframe.apply(
             lambda m: sqrt(metadata_metric(self.metadata, m)),
             axis=1
@@ -824,16 +834,21 @@ class Simulation_v2(SimulationBase):
         json_location = self.files.get(json_path)["link"]
         h5_truepath = Path(sxs_path_to_system_path(sxs_id_path / h5_path))
         json_truepath = Path(sxs_path_to_system_path(sxs_id_path / json_path))
+        json_truepath = sxs_directory("cache") / json_truepath
         if not Path(json_location).exists() and not json_truepath.exists():
             if not read_config("download", True):
                 raise ValueError(f"{json_truepath} not found and download is disabled")
-            download_file(json_location, sxs_directory("cache") / json_truepath)
+            download_file(json_location, json_truepath)
         return load(
             h5_location, truepath=h5_truepath, group=group, metadata=self.metadata,
             transform_to_inertial=transform_to_inertial
         )
 
 
+class Simulation_v3(Simulation_v2):
+    pass
+
+
 def get_file_info(metadata, sxs_id, download=None):
     # TODO: Allow an existing zenodo_metadata.json file to be used
     from .. import load_via_sxs_id

sxs-2025.0.2/sxs/simulations/simulations.py

@@ -0,0 +1,2 @@
+"""Container interface to the catalog of SXS simulations"""
+from sxscatalog.simulations.simulations import *

sxs-2025.0.2/sxs/utilities/downloads.py

@@ -0,0 +1,2 @@
+"""A core utility function for downloading efficiently and robustly"""
+from sxscatalog.utilities.downloads import *

sxs-2025.0.2/sxs/utilities/string_converters.py

@@ -0,0 +1 @@
+from sxscatalog.utilities.string_converters import *

sxs-2025.0.2/sxs/utilities/sxs_directories.py

@@ -0,0 +1,69 @@
+"""Functions to find user-specific config and cache directories"""
+
+import re
+import platform
+import functools
+from sxscatalog.utilities import read_config, write_config, sxs_directory
+from .sxs_identifiers import sxs_path_re
+
+_platform_system = platform.system()
+
+
+def sxs_path_to_system_path(path):
+    r"""Translate SXS path to a system-compatible path
+
+    Parameters
+    ----------
+    path : str
+        SXS-style path to a file — for example, r"SXS:BBH:0123\Lev4:Horizons.h5"
+        becomes r"SXS_BBH_0123\Lev4_Horizons.h5" on Windows.  Other systems can
+        handle the original path, so are not changed.
+
+    Notes
+    -----
+    SXS-style paths begin with SXS IDs, which contain colon characters.  These
+    colons are incompatible with Windows file systems, so we simply replace the
+    colons with underscores.
+
+    """
+    if _platform_system == "Windows":
+        return sxs_path_re.sub(lambda s: s.group(0).replace(":", "_"), str(path))
+    else:
+        return path
+
+
+def cached_path(path_pattern):
+    """Return path to file in local cache
+
+    Parameters
+    ----------
+    path_pattern : str
+        A pattern to search for among the catalog files.  See the docstring of
+        `sxs.Catalog.select` for details about how this pattern is used.
+
+    Returns
+    -------
+    path : pathlib.Path
+        Full path to file on this system.  The file may not exist.
+
+    Raises
+    ------
+    StopIteration
+        When no result is found for the input `path_pattern`.
+
+    Notes
+    -----
+    This function returns just one path, corresponding to the first result returned
+    by `catalog.select_files(path_pattern)`.
+
+    """
+    import contextlib
+    from .. import load
+    with contextlib.redirect_stdout(None):
+        catalog = load("catalog")
+    file_infos = catalog.select_files(path_pattern)
+    sxs_path, file_info = next(iter(file_infos.items()))
+    cache_path = sxs_directory("cache")
+    truepath = sxs_path_to_system_path(file_info.get("truepath", sxs_path))
+    path = cache_path / truepath
+    return path

sxs-2025.0.2/sxs/utilities/sxs_identifiers.py

@@ -0,0 +1,2 @@
+"""Simple regexes to understand SXS IDs"""
+from sxscatalog.utilities.sxs_identifiers import *

{sxs-2024.0.44 → sxs-2025.0.2}/sxs/waveforms/format_handlers/lvc.py

@@ -36,11 +36,12 @@ def to_lvc_conventions(
 ):
     r"""Return SXS waveform in LVC conventions.
 
-    This is the function underpinning `sxs.load_lvc`.  Essentially,
-    that function is a fairly thin wrapper around this one; it just
-    loads the `h` and `horizons` data and passes it to this function.
-    For explanation of what this function does, the inputs, and
-    outputs, see that function's docstring.
+    This is the function underpinning the `to_lvk` method of the
+    various `Simulation` types.  Essentially, that function is a
+    fairly thin wrapper around this one; it just loads the `h` and
+    `horizons` data and passes it to this function.  For explanation
+    of what this function does, the inputs, and outputs, see that
+    function's docstring.
 
     """
     if t_ref is None and f_ref is None:

{sxs-2024.0.44 → sxs-2025.0.2}/sxs/waveforms/format_handlers/rotating_paired_diff_multishuffle_bzip2.py

@@ -413,6 +413,12 @@ def load(
             raise ValueError(message)
 
     file_name_str = str(file_name)
+    if file_name_str.endswith(".json"):
+        # This is just a JSON file with the "sxs_format" key, not an H5 file
+        # with the data in it.  Just return the JSON data.
+        from ...handlers import JSONHandler
+        return JSONHandler.load(file_name_str)
+
     group = kwargs.get("group", None)
     if ".h5" in file_name_str and not file_name_str.endswith(".h5"):
         file_name_str, group = file_name_str.split(".h5")

{sxs-2024.0.44 → sxs-2025.0.2}/sxs/zenodo/__init__.py

@@ -4,7 +4,7 @@
 
 import os.path
 from pathlib import Path
-
+from sxscatalog.utilities import path_to_invenio, invenio_to_path
 from .api import Login, Deposit, Records
 from . import catalog, simannex, surrogatemodeling
 
@@ -12,16 +12,6 @@ from . import catalog, simannex, surrogatemodeling
 # The other python API interface I found is here: https://github.com/moble/zenodo-python
 
 
-def path_to_invenio(file_path):
-    """Convert a file path to an invenio-compatible name"""
-    return str(file_path).replace(os.path.sep, ":")
-
-
-def invenio_to_path(file_name):
-    """Convert an invenio-compatible name to a file path"""
-    return Path(file_name.replace(":", os.path.sep))
-
-
 def translate(sxs_identifier, url=False):
     """Query data.black-holes.org to get the current Zenodo equivalent of the given SXS ID
 

{sxs-2024.0.44 → sxs-2025.0.2}/tests/conftest.py

@@ -29,7 +29,7 @@ GITHUB_ACTIONS_MACOS = (
 # will work adequately.  Note that if macos tests are failing, it may be
 # time to increment the cache version number in .github/workflows/build.yml;
 # try that before re-enabling this decorator.
-if False: # GITHUB_ACTIONS_MACOS:
+if GITHUB_ACTIONS_MACOS:
     skip_macOS_GH_actions_downloads = pytest.mark.skip(
         reason="macOS runners on GitHub Actions have connectivity problems"
     )

sxs-2024.0.44/sxs/__version__.py

@@ -1 +0,0 @@
-__version__ = "2024.0.44"