sxs 2024.0.29__tar.gz → 2024.0.30__tar.gz

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

@@ -31,6 +31,9 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
         python-version: ['3.10', '3.13']
+        exclude:
+          - os: windows-latest
+            python-version: '3.13'
 
     steps:
       - name: Skip replicates on main branch

{sxs-2024.0.29 → 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.29
-date-released: 2025-02-12
+version: 2024.0.30
+date-released: 2025-02-13

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sxs
-Version: 2024.0.29
+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.29 → 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.29 → 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,6 +521,8 @@ class Simulations(collections.OrderedDict):
             # simulations["end_of_trajectory_time"].map(floater),
             # simulations["merger_time"].map(floater),
             simulations["number_of_orbits"].map(floater),
+            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"],
@@ -523,6 +537,14 @@ class Simulations(collections.OrderedDict):
             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.29/sxs/__version__.py

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