sxs 2025.0.14__tar.gz → 2025.0.16__tar.gz

{sxs-2025.0.14 → sxs-2025.0.16}/CITATION.cff

@@ -16,5 +16,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2025.0.14
-date-released: 2025-05-14
+version: 2025.0.16
+date-released: 2025-05-29

{sxs-2025.0.14 → sxs-2025.0.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sxs
-Version: 2025.0.14
+Version: 2025.0.16
 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-2025.0.14 → sxs-2025.0.16}/docs/tutorials/00-Introduction.ipynb

@@ -6,7 +6,7 @@
    "source": [
     "# Introduction\n",
     "\n",
-    "This series of notebooks describes the `sxs` python package, which provides an interface to the data produced by the Simulating eXtreme Spacetimes collaboration.  All that data is hosted on [Zenodo](https://zenodo.org/communities/sxs) and [CaltechDATA](https://data.caltech.edu/).  Each simulation gets its own DOI and its own web page — like [this one](https://doi.org/10.5281/zenodo.1213436), for example.  But you want an easier way to get the data than clicking on links.  This package will do that for you.\n",
+    "This series of notebooks describes the `sxs` python package, which provides an interface to the data produced by the Simulating eXtreme Spacetimes collaboration.  All that data is hosted on [Zenodo](https://zenodo.org/communities/sxs) and [CaltechDATA](https://data.caltech.edu/).  Each simulation gets its own DOI and its own web page — like [DOI 10.26138/SXS:BBH:4001](https://doi.org/10.26138/SXS:BBH:4001), for example, which redirects to its CaltechDATA page.  But you want an easier way to get the data than clicking on links.  This package will do that for you.\n",
     "\n",
     "The documentation is [here](https://sxs.readthedocs.io/en/main/).  The github page is [here](https://github.com/sxs-collaboration/sxs/).  Please feel free to open issues to report problems, or pull requests to fix them."
    ]
@@ -251,10 +251,10 @@
     "\n",
     "It is probably best to go through these notebooks in order:\n",
     "\n",
-    "  1. [The catalog `DataFrame` interface](/tutorials/01-Catalog_Dataframe)\n",
-    "  2. [The `Simulation` interface](/tutorials/02-Simulation)\n",
-    "  3. [Data describing `Horizons`](/tutorials/03-Horizons)\n",
-    "  4. [Introduction to `WaveformModes` objects](/tutorials/04-Waveforms)"
+    "  1. [The catalog `DataFrame` interface](../01-Catalog_Dataframe)\n",
+    "  2. [The `Simulation` interface](../02-Simulation)\n",
+    "  3. [Data describing `Horizons`](../03-Horizons)\n",
+    "  4. [Introduction to `WaveformModes` objects](../04-Waveforms)"
    ]
   }
  ],

{sxs-2025.0.14 → sxs-2025.0.16}/docs/tutorials/01-Catalog_Dataframe.ipynb

@@ -3345,7 +3345,7 @@
    "source": [
     "The `simulations` object, especially when agumented with the `dataframe`, provides powerful methods for selecting the particular simulations we are interested in.  Once we have done so, we need to load and interact with the simulations.\n",
     "\n",
-    "Continue with the [introduction to the `Simulation` objects](/tutorials/02-Simulation)."
+    "Continue with the [introduction to the `Simulation` objects](../02-Simulation)."
    ]
   }
  ],

{sxs-2025.0.14 → sxs-2025.0.16}/docs/tutorials/02-Simulation.ipynb

@@ -664,8 +664,8 @@
    "source": [
     "The objects returned will be the subject of the next two notebooks in this series:\n",
     "\n",
-    "- [`Horizons`](/tutorials/03-Horizons)\n",
-    "- [`WaveformModes`](/tutorials/04-Waveforms)"
+    "- [`Horizons`](../03-Horizons)\n",
+    "- [`WaveformModes`](../04-Waveforms)"
    ]
   }
  ],

{sxs-2025.0.14 → sxs-2025.0.16}/docs/tutorials/03-Horizons.ipynb

@@ -394,7 +394,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Continue with the [introduction to waveforms](/tutorials/04-Waveforms)."
+    "Continue with the [introduction to waveforms](../04-Waveforms)."
    ]
   }
  ],

sxs-2025.0.16/sxs/__version__.py

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

{sxs-2025.0.14 → sxs-2025.0.16}/sxs/citation.py

@@ -30,6 +30,9 @@ def cite(*sxs_ids, bibtex=True):
     from . import doi_prefix, load, __version__
     from . import sxs_id as sxs_identifier
 
+    if len(sxs_ids) == 1 and isinstance(sxs_ids[0], (list, tuple)):
+        sxs_ids = tuple(sxs_ids[0])
+
     simulations = load("simulations")
 
     # Get the DOI for this version of this package

{sxs-2025.0.14 → sxs-2025.0.16}/sxs/handlers.py

@@ -199,29 +199,36 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
     -----
     This function can load data in various ways.
 
-      1) Given an absolute or relative path to a local file, it just
-         loads the data directly.
-
-      2) If `truepath` is set, and points to a file that exists —
+      1) If `truepath` is set, and points to a file that exists —
          whether absolute, relative to the current working directory,
          or relative to the cache directory — that file will be
          loaded.
 
-      3) If `location` is a valid URL including the scheme (https://,
+      2) Given an absolute or relative path to a local file, it just
+         loads the data directly.
+
+      3) If `location` is one of "simulations" or "dataframe" (or the
+         deprecated "catalog"), the corresponding catalog data is
+         loaded.  The "simulations" option returns a dictionary mapping
+         SXS IDs to raw metadata, while "dataframe" returns a pandas
+         DataFrame indexed by SXS ID, but the metadata is processed
+         into more consistent form.
+
+      4) If `location` is a valid URL including the scheme (https://,
          or http://), it will be downloaded regardless of the
          `download` parameter and optionally cached.
 
-      4) Given an SXS simulation specification — like "SXS:BBH:1234",
+      5) Given an SXS simulation specification — like "SXS:BBH:1234",
          "SXS:BBH:1234v2.0", "SXS:BBH:1234/Lev5", or
          "SXS:BBH:1234v2.0/Lev5" — the simulation is loaded as an
          `sxs.Simulation` object.
 
-      5) Given an SXS path — like
+      6) Given an SXS path — like
          "SXS:BBH:1234/Lev5/h_Extrapolated_N2.h5" — the file is
          located in the catalog for details.  This function then looks
          in the local cache directory and loads it if present.
 
-      6) If the SXS path is not found in the cache directory and
+      7) If the SXS path is not found in the cache directory and
          `download` is set to `True` (when this function is called, or
          in the sxs config file) this function attempts to download
          the data.  Note that `download` must be explicitly set in
@@ -263,6 +270,15 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
         elif truepath and (testpath := cache_path / sxs_path_to_system_path(truepath)).exists():
             path = testpath
 
+        elif _safe_resolve_exists(path):
+            pass  # We already have the correct path
+
+        elif location == "catalog":
+            return Catalog.load(download=download)
+
+        elif location in ["simulations", "dataframe"]:
+            return sxscatalog.load(location, download=download, **kwargs)
+
         elif _safe_resolve_exists(h5_path):
             path = h5_path
 
@@ -278,12 +294,6 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
                     raise ValueError(f"File '{truepath}' not found in cache, but downloading turned off")
                 download_file(location, path, progress=progress)
 
-        elif location == "catalog":
-            return Catalog.load(download=download)
-
-        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)
 

{sxs-2025.0.14 → sxs-2025.0.16}/tests/test_simulation.py

@@ -2,7 +2,8 @@ import pytest
 import sxs
 from .conftest import skip_macOS_GH_actions_downloads
 
-@pytest.mark.xfail(reason="Missing files in the catalog should be updated soon")
+
+@skip_macOS_GH_actions_downloads
 def test_catalog_file_sizes():
     simulations = sxs.load("simulations")
     success = True

{sxs-2025.0.14 → sxs-2025.0.16}/tests/test_utilities.py

@@ -98,28 +98,33 @@ def test_sxs_directory_unwritable(directory_type, tmp_path, monkeypatch):
     import os
     import stat
     from pathlib import Path
+    import shutil
 
     d = tmp_path / "unwritable"
-    d.mkdir(mode=0o000)
-    assert d.exists()
-    assert d.is_dir()
-    assert stat.filemode(d.stat().st_mode) == "d---------"
-    assert not os.access(str(d), os.W_OK)
-
-    with monkeypatch.context() as mp:
-        mp.setattr(Path, "home", lambda: d)
-        mp.setenv(f"SXS{directory_type.upper()}DIR", str(d))
-        for dir_type in ["config", "cache"]:
-            mp.delenv(f'XDG_{dir_type.upper()}_HOME', raising=False)
-        sxs.utilities.sxs_directory.cache_clear()
-        with pytest.warns(UserWarning):
-            sxs_dir = sxs.utilities.sxs_directory(directory_type, persistent=True)
-        assert ".sxs" not in str(sxs_dir), (str(sxs_dir), str(d))
-        sxs_config_dir = sxs.utilities.sxs_directory("config", persistent=True)
-        assert str(sxs_config_dir) in str(sxs_dir)
-
-    d.chmod(0o777)
-    time.sleep(0.1)
+    try:
+        d.mkdir(mode=0o000)
+        assert d.exists()
+        assert d.is_dir()
+        assert stat.filemode(d.stat().st_mode) == "d---------"
+        assert not os.access(str(d), os.W_OK)
+
+        with monkeypatch.context() as mp:
+            mp.setattr(Path, "home", lambda: d)
+            mp.setenv(f"SXS{directory_type.upper()}DIR", str(d))
+            for dir_type in ["config", "cache"]:
+                mp.delenv(f'XDG_{dir_type.upper()}_HOME', raising=False)
+            sxs.utilities.sxs_directory.cache_clear()
+            with pytest.warns(UserWarning):
+                sxs_dir = sxs.utilities.sxs_directory(directory_type, persistent=True)
+            assert ".sxs" not in str(sxs_dir), (str(sxs_dir), str(d))
+            sxs_config_dir = sxs.utilities.sxs_directory("config", persistent=True)
+            assert str(sxs_config_dir) in str(sxs_dir)
+
+        d.chmod(0o777)
+        time.sleep(0.1)
+    finally:
+        # Remove the subdirectory manually, because forking scares the file system
+        shutil.rmtree(str(d))
 
 
 def test_read_write_config(tmp_path, monkeypatch):

sxs-2025.0.14/sxs/__version__.py

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