sxs 2024.0.28__tar.gz → 2024.0.30__tar.gz

{sxs-2024.0.28 → sxs-2024.0.30}/.github/workflows/build.yml

@@ -30,7 +30,10 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ['3.10', '3.12']
+        python-version: ['3.10', '3.13']
+        exclude:
+          - os: windows-latest
+            python-version: '3.13'
 
     steps:
       - name: Skip replicates on main branch
@@ -78,7 +81,7 @@ jobs:
         run: hatch run test
 
       - name: Upload coverage
-        if: "matrix.python-version == '3.12' && matrix.os == 'ubuntu-latest'"
+        if: "matrix.python-version == '3.13' && matrix.os == 'ubuntu-latest'"
         uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
@@ -98,10 +101,10 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v4
 
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: '3.13'
 
       - name: Install Hatch
         run: python -m pip install --disable-pip-version-check --upgrade hatch
@@ -168,28 +171,3 @@ jobs:
         run: |
           hatch build
           hatch publish
-
-
-  binder:
-    name: Trigger a binder rebuild
-    needs: release
-    runs-on: ubuntu-latest
-    if: >-
-        github.ref == 'refs/heads/main'
-        && !contains(github.event.head_commit.message, '[no release]')
-        && (success() || contains(github.event.head_commit.message, '[skip tests]'))
-
-    steps:
-      - name: Trigger other repository
-        # I created a new personal access token via github profile > settings > developer settings >
-        # personal access tokens.  I clicked the "repo" checkbox, created the token, and copied it.
-        # Then, I went to this repo's settings > secrets, and created a new secret named
-        # "MOBLE_TOKEN" with a value of "moble:<token>", where <token> is the copied token.  This
-        # command sends a POST to the other repo, which is set up to build on `workflow_dispatch`.
-        run: |
-          curl \
-          -X POST \
-          -H "Accept: application/vnd.github.v3+json" \
-          -u ${{ secrets.MOBLE_TOKEN }} \
-          https://api.github.com/repos/moble/sxs_notebooks/actions/workflows/binder.yml/dispatches \
-          -d '{"ref":"refs/heads/master"}'

{sxs-2024.0.28 → sxs-2024.0.30}/CITATION.cff

@@ -10,5 +10,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2024.0.28
-date-released: 2025-01-31
+version: 2024.0.30
+date-released: 2025-02-13

{sxs-2024.0.28 → sxs-2024.0.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sxs
-Version: 2024.0.28
+Version: 2024.0.30
 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.30/sxs/__version__.py

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

{sxs-2024.0.28 → sxs-2024.0.30}/sxs/metadata/metadata.py

@@ -23,6 +23,17 @@ def _valid_identifier_to_metadata_key(key):
     return _metadata_key_map.get(key, key.replace('_', '-'))
 
 
+def _backwards_compatibility(metadata):
+    """Deal with the fact that keys have been removed/renamed"""
+    # See also `sxs.simulations.simulations.Simulations.dataframe`;
+    # it's probably a good idea to duplicate whatever is included here
+    # in that function, just to make sure nothing slips through the
+    # cracks.
+    if "number_of_orbits" not in metadata and "number_of_orbits_from_start" in metadata:
+        metadata["number_of_orbits"] = metadata["number_of_orbits_from_start"]
+    return metadata
+
+
 class Metadata(collections.OrderedDict):
     """Interface to metadata
 
@@ -72,25 +83,27 @@ class Metadata(collections.OrderedDict):
         txt_path = path.with_suffix(".txt")
 
         if path.suffix == ".json":
-            return cls.from_json_file(json_path)
+            metadata = cls.from_json_file(json_path)
         elif path.suffix == ".txt":
-            return cls.from_txt_file(txt_path, ignore_invalid_lines=ignore_invalid_lines, cache_json=cache_json)
+            metadata = cls.from_txt_file(txt_path, ignore_invalid_lines=ignore_invalid_lines, cache_json=cache_json)
         else:
             json_exists = json_path.exists()
             txt_exists = txt_path.exists()
             if json_exists and not txt_exists:
-                return cls.from_json_file(json_path)
+                metadata = cls.from_json_file(json_path)
             elif txt_exists and not json_exists:
-                return cls.from_txt_file(txt_path, ignore_invalid_lines=ignore_invalid_lines, cache_json=cache_json)
+                metadata = cls.from_txt_file(txt_path, ignore_invalid_lines=ignore_invalid_lines, cache_json=cache_json)
             elif json_exists and txt_exists:
                 json_time = json_path.stat().st_mtime
                 txt_time = txt_path.stat().st_mtime
                 if txt_time > json_time:
-                    return cls.from_txt_file(txt_path, ignore_invalid_lines=ignore_invalid_lines, cache_json=cache_json)
+                    metadata = cls.from_txt_file(txt_path, ignore_invalid_lines=ignore_invalid_lines, cache_json=cache_json)
                 else:
-                    return cls.from_json_file(json_path)
+                    metadata = cls.from_json_file(json_path)
             else:
                 raise ValueError(f"Could not find file named '{json_path}' or '{txt_path}'")
+            
+            return _backwards_compatibility(metadata)
 
     load = from_file
 
@@ -113,7 +126,7 @@ class Metadata(collections.OrderedDict):
         """
         import json
         # noinspection PyTypeChecker
-        return json.load(json_data, object_pairs_hook=cls)
+        return _backwards_compatibility(json.load(json_data, object_pairs_hook=cls))
 
     @classmethod
     def from_json_file(cls, json_file):
@@ -136,7 +149,7 @@ class Metadata(collections.OrderedDict):
             # noinspection PyTypeChecker
             metadata = json.load(metadata_file, object_pairs_hook=cls)
         metadata["metadata_path"] = str(json_file)
-        return metadata
+        return _backwards_compatibility(metadata)
 
     @classmethod
     def from_txt_file(cls, txt_file, ignore_invalid_lines=False, cache_json=True):
@@ -259,7 +272,7 @@ class Metadata(collections.OrderedDict):
             metadata.to_json_file(path.with_suffix(".json"))
 
         metadata["metadata_path"] = str(txt_file)
-        return metadata
+        return _backwards_compatibility(metadata)
 
     def to_json(self, indent=4, separators=(",", ": ")):
         """Export to JSON string"""

{sxs-2024.0.28 → sxs-2024.0.30}/sxs/simulations/simulation.py

@@ -133,7 +133,7 @@ def Simulation(location, *args, **kwargs):
     url = f"{doi_url}{sxs_id}"
 
     # Deal with "superseded_by" field, or "deprecated" keyword in the metadata
-    deprecated = ("deprecated" in metadata.get("keywords", []) or metadata.get("superseded_by", False))
+    deprecated = ("deprecated" in metadata.get("keywords", []) )#or metadata.get("superseded_by", False))
     if not kwargs.get("ignore_deprecation", False):
         auto_supersede = kwargs.get("auto_supersede", read_config("auto_supersede", False))
         if (
@@ -160,6 +160,12 @@ def Simulation(location, *args, **kwargs):
                         + "specify a version to load this waveform anyway."
                     )
                 elif auto_supersede and isinstance(superseded_by, str):
+                    # raise NotImplementedError(
+                    #     f"\nSimulation '{sxs_id}' cannot be automatically superseded.\n"
+                    #     + "The auto_supersede option is temporarily disabled.  The superseding\n"
+                    #     + "simulations have been removed from the metadata, and the new function\n"
+                    #     + "to load them has not yet been implemented.  Please specify a version.\n"
+                    # )
                     message = f"\nSimulation '{sxs_id}' is being automatically superseded by '{superseded_by}'."
                     warn(message)
                     new_location = f"{superseded_by}{input_version}"

{sxs-2024.0.28 → sxs-2024.0.30}/sxs/simulations/simulations.py

@@ -404,6 +404,18 @@ class Simulations(collections.OrderedDict):
 
         simulations = pd.DataFrame.from_dict(self, orient="index")
 
+        # See also below for "number_of_orbits" field.
+        # See also `sxs.metadata.metadata._backwards_compatibility`;
+        # it's probably a good idea to duplicate whatever is included
+        # here in that function, just to make sure nothing slips
+        # through the cracks.
+        for col in [
+            "number_of_orbits", "number_of_orbits_from_start",
+            "number_of_orbits_from_reference_time"
+        ]:
+            if col not in simulations.columns:
+                simulations[col] = np.nan
+
         def floater(x):
             try:
                 f = float(x)
@@ -509,7 +521,9 @@ class Simulations(collections.OrderedDict):
             # simulations["end_of_trajectory_time"].map(floater),
             # simulations["merger_time"].map(floater),
             simulations["number_of_orbits"].map(floater),
-            simulations["superseded_by"],
+            simulations["number_of_orbits_from_start"].map(floater),
+            simulations["number_of_orbits_from_reference_time"].map(floater),
+            # simulations["superseded_by"],
             simulations["DOI_versions"],
             simulations["keywords"],
             simulations["date_link_earliest"].map(datetime_from_string),
@@ -519,10 +533,18 @@ class Simulations(collections.OrderedDict):
         ), axis=1))
 
         sims_df.insert(0, "deprecated", (
-            ~sims_df.superseded_by.isna()
-            | sims_df["keywords"].map(lambda ks: "deprecated" in ks)
+            # ~sims_df.superseded_by.isna() |
+            sims_df["keywords"].map(lambda ks: "deprecated" in ks)
         ))
 
+        # See also `sxs.metadata.metadata._backwards_compatibility`;
+        # it's probably a good idea to duplicate whatever is included
+        # here in that function, just to make sure nothing slips
+        # through the cracks.
+        sims_df["number_of_orbits"] = sims_df["number_of_orbits"].fillna(
+            sims_df["number_of_orbits_from_start"]
+        )
+
         # We have ignored the following fields present in the
         # simulations.json file (as of 2024-08-04), listed here with
         # the number of non-null entries:

sxs-2024.0.30/tests/test_simulation.py

@@ -0,0 +1,67 @@
+import pytest
+import sxs
+from .conftest import skip_macOS_GH_actions_downloads
+
+
+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
+
+
+# @skip_macOS_GH_actions_downloads
+# @pytest.mark.parametrize("loader", [sxs.Simulation, sxs.load])
+# def test_superseded_by_single(loader):
+#     simulation = "SXS:BBH:0001"
+#     # NOTE: These tests as written will only work so long as only one
+#     # simulation is listed in the given simulation's `superseded_by`
+#     # field.  If more are added, this test will need to be changed to
+#     # use a simulation that still has just one.
+#     with pytest.raises(ValueError):
+#         loader(f"{simulation}")
+#     with pytest.warns(UserWarning):
+#         s = loader(f"{simulation}v2.0")
+#     assert s.sxs_id_stem == simulation
+#     s = loader(f"{simulation}", ignore_deprecation=True)
+#     assert s.sxs_id_stem == simulation
+#     s = loader(f"{simulation}v2.0", ignore_deprecation=True)
+#     assert s.sxs_id_stem == simulation
+#     with pytest.warns(UserWarning):
+#         s = loader(f"{simulation}", auto_supersede=True)
+#     assert s.sxs_id_stem != simulation
+#     with pytest.warns(UserWarning):
+#         s = loader(f"{simulation}v2.0", auto_supersede=True)
+#     assert s.sxs_id_stem != simulation
+#     s = loader(f"{simulation}", ignore_deprecation=True, auto_supersede=True)
+#     assert s.sxs_id_stem == simulation
+#     s = loader(f"{simulation}v2.0", ignore_deprecation=True, auto_supersede=True)
+#     assert s.sxs_id_stem == simulation
+
+
+# @skip_macOS_GH_actions_downloads
+# @pytest.mark.parametrize("loader", [sxs.Simulation, sxs.load])
+# def test_superseded_by_multiple(loader):
+#     simulation = "SXS:BBH:0030"
+#     # NOTE: These tests assume that multiple simulations are listed in
+#     # the given simulation's `superseded_by` field.  If that changes
+#     # for some reason, this test will need to be changed to use a
+#     # simulation that still has multiple simulations.
+#     with pytest.raises(ValueError):
+#         loader(f"{simulation}")
+#     with pytest.warns(UserWarning):
+#         s = loader(f"{simulation}v2.0")
+#     assert s.sxs_id_stem == simulation
+#     s = loader(f"{simulation}", ignore_deprecation=True)
+#     assert s.sxs_id_stem == simulation
+#     s = loader(f"{simulation}v2.0", ignore_deprecation=True)
+#     assert s.sxs_id_stem == simulation
+#     with pytest.raises(ValueError):
+#         loader(f"{simulation}", auto_supersede=True)
+#     with pytest.raises(ValueError):
+#         loader(f"{simulation}v2.0", auto_supersede=True)
+#     s = loader(f"{simulation}", ignore_deprecation=True, auto_supersede=True)
+#     assert s.sxs_id_stem == simulation
+#     s = loader(f"{simulation}v2.0", ignore_deprecation=True, auto_supersede=True)
+#     assert s.sxs_id_stem == simulation

sxs-2024.0.28/sxs/__version__.py

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

sxs-2024.0.28/tests/test_simulation.py

@@ -1,67 +0,0 @@
-import pytest
-import sxs
-from .conftest import skip_macOS_GH_actions_downloads
-
-
-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
-
-
-@skip_macOS_GH_actions_downloads
-@pytest.mark.parametrize("loader", [sxs.Simulation, sxs.load])
-def test_superseded_by_single(loader):
-    simulation = "SXS:BBH:0001"
-    # NOTE: These tests as written will only work so long as only one
-    # simulation is listed in the given simulation's `superseded_by`
-    # field.  If more are added, this test will need to be changed to
-    # use a simulation that still has just one.
-    with pytest.raises(ValueError):
-        loader(f"{simulation}")
-    with pytest.warns(UserWarning):
-        s = loader(f"{simulation}v2.0")
-    assert s.sxs_id_stem == simulation
-    s = loader(f"{simulation}", ignore_deprecation=True)
-    assert s.sxs_id_stem == simulation
-    s = loader(f"{simulation}v2.0", ignore_deprecation=True)
-    assert s.sxs_id_stem == simulation
-    with pytest.warns(UserWarning):
-        s = loader(f"{simulation}", auto_supersede=True)
-    assert s.sxs_id_stem != simulation
-    with pytest.warns(UserWarning):
-        s = loader(f"{simulation}v2.0", auto_supersede=True)
-    assert s.sxs_id_stem != simulation
-    s = loader(f"{simulation}", ignore_deprecation=True, auto_supersede=True)
-    assert s.sxs_id_stem == simulation
-    s = loader(f"{simulation}v2.0", ignore_deprecation=True, auto_supersede=True)
-    assert s.sxs_id_stem == simulation
-
-
-@skip_macOS_GH_actions_downloads
-@pytest.mark.parametrize("loader", [sxs.Simulation, sxs.load])
-def test_superseded_by_multiple(loader):
-    simulation = "SXS:BBH:0030"
-    # NOTE: These tests assume that multiple simulations are listed in
-    # the given simulation's `superseded_by` field.  If that changes
-    # for some reason, this test will need to be changed to use a
-    # simulation that still has multiple simulations.
-    with pytest.raises(ValueError):
-        loader(f"{simulation}")
-    with pytest.warns(UserWarning):
-        s = loader(f"{simulation}v2.0")
-    assert s.sxs_id_stem == simulation
-    s = loader(f"{simulation}", ignore_deprecation=True)
-    assert s.sxs_id_stem == simulation
-    s = loader(f"{simulation}v2.0", ignore_deprecation=True)
-    assert s.sxs_id_stem == simulation
-    with pytest.raises(ValueError):
-        loader(f"{simulation}", auto_supersede=True)
-    with pytest.raises(ValueError):
-        loader(f"{simulation}v2.0", auto_supersede=True)
-    s = loader(f"{simulation}", ignore_deprecation=True, auto_supersede=True)
-    assert s.sxs_id_stem == simulation
-    s = loader(f"{simulation}v2.0", ignore_deprecation=True, auto_supersede=True)
-    assert s.sxs_id_stem == simulation