sxs 2024.0.7__tar.gz → 2024.0.8__tar.gz

{sxs-2024.0.7 → sxs-2024.0.8}/.github/workflows/build.yml

@@ -40,6 +40,25 @@ jobs:
         run: |
           echo "skipping_build_and_test_replicate=${skip_replicates}" >> $GITHUB_ENV
 
+      - name: Cache sxs file storage
+        if: ${{ env.skipping_build_and_test_replicate != 'true' }}
+        uses: actions/cache@v4
+        with:
+          key: sxs-${{ runner.os }}-python${{ matrix.python-version }}
+          path: |
+            ~/.sxs
+          restore-keys: |
+            sxs-${{ runner.os }}-
+            sxs-
+
+      - name: Set up Julia
+        if: ${{ env.skipping_build_and_test_replicate != 'true' }}
+        uses: julia-actions/setup-julia@v2
+
+      - name: Cache Julia
+        if: ${{ env.skipping_build_and_test_replicate != 'true' }}
+        uses: julia-actions/cache@v2
+
       - name: Check out code
         if: ${{ env.skipping_build_and_test_replicate != 'true' }}
         uses: actions/checkout@v4
@@ -52,7 +71,7 @@ jobs:
 
       - name: Install Hatch
         if: ${{ env.skipping_build_and_test_replicate != 'true' }}
-        run: pip install --upgrade hatch
+        run: python -m pip install --disable-pip-version-check --upgrade hatch
 
       - name: Run tests
         if: ${{ env.skipping_build_and_test_replicate != 'true' }}
@@ -85,7 +104,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install Hatch
-        run: pip install --upgrade hatch
+        run: python -m pip install --disable-pip-version-check --upgrade hatch
 
       - name: Bump version
         shell: bash

{sxs-2024.0.7 → sxs-2024.0.8}/CITATION.cff

@@ -10,5 +10,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2024.0.7
-date-released: 2024-09-06
+version: 2024.0.8
+date-released: 2024-09-09

{sxs-2024.0.7 → sxs-2024.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2024.0.7
+Version: 2024.0.8
 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/
@@ -166,23 +166,24 @@ horizons = sxs_bbh_1234.horizons
 h = sxs_bbh_1234.h
 ```
 
-[The `catalog`
-object](https://sxs.readthedocs.io/en/main/api/sxs.catalog.catalog/#sxs.catalog.catalog.Catalog)
-contains information about every simulation in the catalog, including all
-available data files, and information about how to get them.  You probably
-don't need to actually know about details like where to get the data, but
-`catalog` can help you find the simulations you care about.  Most importantly,
-`catalog.simulations` is a `dict` object, where the keys are names of
-simulations (like "SXS:BBH:0123") and the values are the same types as [the
+[The `simulations`
+object](https://sxs.readthedocs.io/en/main/api/simulations/) contains
+information about every simulation in the catalog, including all
+available data files, and information about how to get them.  You
+probably don't need to actually know about details like where to get
+the data, but `simulations` can help you find the simulations you care
+about.  It is a `dict` object, where the keys are names of simulations
+(like "SXS:BBH:0123") and the values are the same types as [the
 `metadata`
 object](https://sxs.readthedocs.io/en/main/api/sxs.metadata.metadata/#sxs.metadata.metadata.Metadata),
-which contains metadata about that simulation — things like mass ratio, spins,
-etc.  This `metadata` reflects the actual output of the simulations, which
-leads to some inconsistencies in their formats.  A more consistent interface
-(though it is biased toward returning NaNs where a human might glean more
-information) is provided by `catalog.table`, which returns a
-[`pandas`](https://pandas.pydata.org/docs/) `DataFrame` with specific data
-types for each column.
+which contains metadata about that simulation — things like mass
+ratio, spins, etc.  This `metadata` reflects the actual output of the
+simulations, which leads to some inconsistencies in their formats.  A
+more consistent interface (though it is biased toward returning NaNs
+where a human might glean more information) is provided by
+`simulations.dataframe`, which returns a
+[`pandas`](https://pandas.pydata.org/docs/) `DataFrame` with specific
+data types for each column.
 
 The actual data itself is primarily contained in the next two objects.  [The
 `horizons`

{sxs-2024.0.7 → sxs-2024.0.8}/README.md

@@ -94,23 +94,24 @@ horizons = sxs_bbh_1234.horizons
 h = sxs_bbh_1234.h
 ```
 
-[The `catalog`
-object](https://sxs.readthedocs.io/en/main/api/sxs.catalog.catalog/#sxs.catalog.catalog.Catalog)
-contains information about every simulation in the catalog, including all
-available data files, and information about how to get them.  You probably
-don't need to actually know about details like where to get the data, but
-`catalog` can help you find the simulations you care about.  Most importantly,
-`catalog.simulations` is a `dict` object, where the keys are names of
-simulations (like "SXS:BBH:0123") and the values are the same types as [the
+[The `simulations`
+object](https://sxs.readthedocs.io/en/main/api/simulations/) contains
+information about every simulation in the catalog, including all
+available data files, and information about how to get them.  You
+probably don't need to actually know about details like where to get
+the data, but `simulations` can help you find the simulations you care
+about.  It is a `dict` object, where the keys are names of simulations
+(like "SXS:BBH:0123") and the values are the same types as [the
 `metadata`
 object](https://sxs.readthedocs.io/en/main/api/sxs.metadata.metadata/#sxs.metadata.metadata.Metadata),
-which contains metadata about that simulation — things like mass ratio, spins,
-etc.  This `metadata` reflects the actual output of the simulations, which
-leads to some inconsistencies in their formats.  A more consistent interface
-(though it is biased toward returning NaNs where a human might glean more
-information) is provided by `catalog.table`, which returns a
-[`pandas`](https://pandas.pydata.org/docs/) `DataFrame` with specific data
-types for each column.
+which contains metadata about that simulation — things like mass
+ratio, spins, etc.  This `metadata` reflects the actual output of the
+simulations, which leads to some inconsistencies in their formats.  A
+more consistent interface (though it is biased toward returning NaNs
+where a human might glean more information) is provided by
+`simulations.dataframe`, which returns a
+[`pandas`](https://pandas.pydata.org/docs/) `DataFrame` with specific
+data types for each column.
 
 The actual data itself is primarily contained in the next two objects.  [The
 `horizons`

sxs-2024.0.8/sxs/__version__.py

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

{sxs-2024.0.7 → sxs-2024.0.8}/sxs/handlers.py

@@ -256,10 +256,10 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
     json_path = path.with_suffix('.json')
 
     if not path.exists():
-        if truepath and (testpath := pathlib.Path(truepath).expanduser()).exists():
+        if truepath and (testpath := pathlib.Path(sxs_path_to_system_path(truepath)).expanduser()).exists():
             path = testpath
 
-        elif truepath and (testpath := cache_path / truepath).exists():
+        elif truepath and (testpath := cache_path / sxs_path_to_system_path(truepath)).exists():
             path = testpath
 
         elif _safe_resolve_exists(h5_path):
@@ -271,7 +271,7 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
         elif "scheme" in url.parse(location):
             m = url.parse(location)
             truepath = truepath or urllib.request.url2pathname(f"{m['host']}/{m['port']}/{m['resource']}")
-            path = cache_path / truepath
+            path = cache_path / sxs_path_to_system_path(truepath)
             if not path.resolve().exists():
                 if download is False:  # Again, we want literal False, not casting to False
                     raise ValueError(f"File '{truepath}' not found in cache, but downloading turned off")
@@ -298,7 +298,7 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
             paths = []
             for sxs_path, file_info in selections.items():
                 truepath = truepath or sxs_path_to_system_path(file_info.get("truepath", sxs_path))
-                path = cache_path / truepath
+                path = cache_path / sxs_path_to_system_path(truepath)
                 if not path.resolve().exists():
                     download_url = file_info["download"]
                     download_file(download_url, path, progress=progress)

{sxs-2024.0.7 → sxs-2024.0.8}/sxs/simulations/simulation.py

@@ -96,7 +96,6 @@ def Simulation(location, *args, **kwargs):
     
     """
     from .. import load, sxs_directory
-    from ..utilities import sxs_path_to_system_path
 
     # Extract the simulation ID, version, and Lev from the location string
     simulation_id, input_version = sxs_id_and_version(location)
@@ -299,16 +298,17 @@ class SimulationBase:
         self.deprecated = kwargs.get("deprecated", False)
 
     def __repr__(self):
-        chi1 = self.metadata.reference_dimensionless_spin1
-        chi2 = self.metadata.reference_dimensionless_spin2
+        chi1 = self.series["reference_dimensionless_spin1"]
+        chi2 = self.series["reference_dimensionless_spin2"]
+        e = self.metadata.reference_eccentricity
         construction = f"""{type(self).__qualname__}("{self.location}")\n# """
         if self.deprecated:
             construction += "DEPRECATED "
-        construction += f"{self.metadata.number_of_orbits:.3g}-orbit "
+        construction += f"n_orbits={self.metadata.number_of_orbits:.3g} "
         construction += f"q={self.metadata.reference_mass_ratio:.3g} "
         construction += f"""chi1=[{", ".join(f"{c:.3g}" for c in chi1)}] """
         construction += f"""chi2=[{", ".join(f"{c:.3g}" for c in chi2)}] """
-        construction += f"e={self.metadata.reference_eccentricity:.3g} simulation"
+        construction += f"e={e:.3g} simulation" if type(e) is float else f"{e=} simulation"
         return construction
 
     def __str__(self):
@@ -332,14 +332,16 @@ class SimulationBase:
 
     def load_horizons(self):
         from .. import load
-        sxs_id_path = Path(sxs_path_to_system_path(self.sxs_id))
+        sxs_id_path = Path(self.sxs_id)
         horizons_path = self.horizons_path
         horizons_location = self.files.get(horizons_path)["link"]
-        horizons_truepath = sxs_id_path / sxs_path_to_system_path(horizons_path)
+        horizons_truepath = Path(sxs_path_to_system_path(sxs_id_path / horizons_path))
         return load(horizons_location, truepath=horizons_truepath)
 
     @property
     def horizons(self):
+        if self.horizons_path not in self.files:
+            raise ValueError(f"Horizons data is not available for simulation {self.sxs_id}")
         if not hasattr(self, "_horizons"):
             self._horizons = self.load_horizons()
         return self._horizons
@@ -427,7 +429,7 @@ class Simulation_v1(SimulationBase):
     
     def load_horizons(self):
         from .. import load
-        sxs_id_path = Path(sxs_path_to_system_path(self.sxs_id))
+        sxs_id_path = Path(self.sxs_id)
         horizons_path = self.horizons_path
         if horizons_path in self.files:
             horizons_location = self.files.get(horizons_path)["link"]
@@ -436,7 +438,7 @@ class Simulation_v1(SimulationBase):
                 horizons_location = self.files.get(extended_horizons_path)["link"]
             else:
                 raise ValueError(f"File '{horizons_path}' not found in simulation files")
-        horizons_truepath = sxs_id_path / sxs_path_to_system_path(horizons_path)
+        horizons_truepath = Path(sxs_path_to_system_path(sxs_id_path / horizons_path))
         return load(horizons_location, truepath=horizons_truepath)
 
     @property
@@ -472,8 +474,8 @@ class Simulation_v1(SimulationBase):
                 location = self.files.get(extended_file_name)["link"]
             else:
                 raise ValueError(f"File '{file_name}' not found in simulation files")
-        sxs_id_path = Path(sxs_path_to_system_path(self.sxs_id))
-        truepath = sxs_id_path / sxs_path_to_system_path(file_name)
+        sxs_id_path = Path(self.sxs_id)
+        truepath = Path(sxs_path_to_system_path(sxs_id_path / file_name))
         w = load(location, truepath=truepath, extrapolation_order=group)
         w.metadata = self.metadata
         return w
@@ -517,15 +519,15 @@ class Simulation_v2(SimulationBase):
     def load_waveform(self, file_name, group):
         from .. import load
         # Note that `name` should not have the file ending on input,
-        # but we will strip it regardless with `.stem`.
-        file_name = Path(file_name).stem
-        sxs_id_path = Path(sxs_path_to_system_path(self.sxs_id))
-        h5_path = f"{file_name}.h5"
-        json_path = f"{file_name}.json"
+        # but we will replace it regardless with `.with_suffix`.
+        file_name = Path(file_name)
+        sxs_id_path = Path(self.sxs_id)
+        h5_path = str(file_name.with_suffix(".h5"))
+        json_path = str(file_name.with_suffix(".json"))
         h5_location = self.files.get(h5_path)["link"]
         json_location = self.files.get(json_path)["link"]
-        h5_truepath = sxs_id_path / sxs_path_to_system_path(h5_path)
-        json_truepath = sxs_id_path / sxs_path_to_system_path(json_path)
+        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))
         if not json_truepath.exists():
             if not read_config("download", True):
                 raise ValueError(f"{json_truepath} not found and download is disabled")

{sxs-2024.0.7 → sxs-2024.0.8}/sxs/simulations/simulations.py

@@ -54,7 +54,8 @@ class Simulations(collections.OrderedDict):
                 remote_timestamp = datetime.strptime(
                     response.headers["Last-Modified"], "%a, %d %b %Y %H:%M:%S GMT"
                 ).replace(tzinfo=timezone.utc)
-        except:
+        except Exception as e:
+            print("Got exception while trying to get the remote timestamp:", e)
             failed = True
         if failed:
             print(

{sxs-2024.0.7 → sxs-2024.0.8}/sxs/utilities/__init__.py

@@ -19,6 +19,7 @@ from .sxs_identifiers import (
     lev_regex, lev_re,
     sxs_id_version_lev_regex, sxs_id_version_lev_re,
     sxs_id_version_lev_exact_regex, sxs_id_version_lev_exact_re,
+    sxs_path_regex, sxs_path_re,
     sxs_id, sxs_id_and_version,
     lev_number, simulation_title, sxs_id_to_url,
 )

{sxs-2024.0.7 → sxs-2024.0.8}/sxs/utilities/sxs_directories.py

@@ -3,9 +3,8 @@
 import re
 import platform
 import functools
-from .sxs_identifiers import sxs_identifier_regex
+from .sxs_identifiers import sxs_path_re
 
-_sxs_identifier_regex = re.compile(sxs_identifier_regex)
 _platform_system = platform.system()
 
 
@@ -215,12 +214,14 @@ def sxs_directory(directory_type, persistent=True):
 
 
 def sxs_path_to_system_path(path):
-    """Translate SXS path to a system-compatible path
+    r"""Translate SXS path to a system-compatible path
 
     Parameters
     ----------
     path : str
-        SXS-style path to a file — for example, "SXS:BBH:0123/Lev4/Horizons.h5"
+        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
     -----
@@ -230,7 +231,7 @@ def sxs_path_to_system_path(path):
 
     """
     if _platform_system == "Windows":
-        return _sxs_identifier_regex.sub(lambda s: s.group(0).replace(":", "_"), str(path))
+        return sxs_path_re.sub(lambda s: s.group(0).replace(":", "_"), str(path))
     else:
         return path
 

{sxs-2024.0.7 → sxs-2024.0.8}/sxs/utilities/sxs_identifiers.py

@@ -1,19 +1,26 @@
 """Simple regexes to understand SXS IDs"""
 
 import re
+import os
+
+sep_regex = r"(:|/)" if os.sep == "/" else r"(:|/|\\)"
 
 sxs_identifier_regex = (
     r"(?P<sxs_identifier>SXS:(?P<simulation_type>BBH|BHNS|NSNS)(?:_ExtCCE)?:"
     r"(?P<sxs_number>[0-9]+))(?:(v|V)(?P<version>[0-9.]+))?"
 )
 lev_regex = r"Lev(?P<lev>-?[0-9]+)"
-sxs_id_version_lev_regex = sxs_identifier_regex + rf"(?:(:|/){lev_regex})?"
+sxs_id_version_lev_regex = sxs_identifier_regex + rf"(?:{sep_regex}{lev_regex})?"
 sxs_id_version_lev_exact_regex = f"^{sxs_id_version_lev_regex}$"
 
+file_regex = r"(?P<file>[a-zA-Z0-9_]+\.[a-zA-Z0-9]+)"
+sxs_path_regex = sxs_id_version_lev_regex + rf"(?:{sep_regex}{file_regex})?"
+
 sxs_identifier_re = re.compile(sxs_identifier_regex)
 lev_re = re.compile(lev_regex)
 sxs_id_version_lev_re = re.compile(sxs_id_version_lev_regex)
 sxs_id_version_lev_exact_re = re.compile(sxs_id_version_lev_exact_regex)
+sxs_path_re = re.compile(sxs_path_regex)
 
 def sxs_id(s, default="", include_version=False):
     """Return the SXS ID contained in the input string

{sxs-2024.0.7 → sxs-2024.0.8}/tests/test_horizons.py

@@ -56,3 +56,19 @@ def test_xmb_format():
             d_spec = getattr(h_spec, attr)
             d_xmb = getattr(h_xmb, attr)
             assert np.array_equal(d_spec, d_xmb)
+
+
+def test_horizon_existence():
+    bhbh = sxs.load("SXS:BBH:0001", auto_supersede=True)
+    bhbh_horizon = bhbh.horizons
+    assert bhbh_horizon.A is not None
+    assert bhbh_horizon.B is not None
+    assert bhbh_horizon.C is not None
+    bhns = sxs.load("SXS:BHNS:0001", auto_supersede=True)
+    bhns_horizon = bhns.horizons
+    assert bhns_horizon.A is not None
+    assert bhns_horizon.B is None
+    assert bhns_horizon.C is None
+    nsns = sxs.load("SXS:NSNS:0001", auto_supersede=True)
+    with pytest.raises(ValueError, match="Horizons data is not available for simulation"):
+        nsns_horizon = nsns.horizons

{sxs-2024.0.7 → sxs-2024.0.8}/tests/test_simulation.py

@@ -2,6 +2,14 @@ import pytest
 import sxs
 
 
+def test_sxs_load_v2():
+    s = sxs.load("SXS:BBH:0001v2.0")
+    assert s.sxs_id_stem == "SXS:BBH:0001"
+    assert s.version == "v2.0"
+    s.h
+    s.horizons
+
+
 @pytest.mark.parametrize("loader", [sxs.Simulation, sxs.load])
 def test_superseded_by_single(loader):
     simulation = "SXS:BBH:0001"

sxs-2024.0.7/sxs/__version__.py

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