sxs 2024.0.28__py3-none-any.whl → 2024.0.30__py3-none-any.whl

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2024.0.28"
+__version__ = "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/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/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.28.dist-info → sxs-2024.0.30.dist-info}/METADATA

@@ -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.28.dist-info → sxs-2024.0.30.dist-info}/RECORD

@@ -1,5 +1,5 @@
 sxs/__init__.py,sha256=hbydsXWR88sFiKExPJ1NHWGEvWRbbJBjSc1irSMYKgY,2623
-sxs/__version__.py,sha256=rDUgberUhElUJ11tdd-wIqTEN89R9jsiJcCrA3lr_Gg,26
+sxs/__version__.py,sha256=fxgBGH8XprJkhrY7eEz-aU7IFQ3A5JmJ9zKlM--2i1E,26
 sxs/handlers.py,sha256=Nc1_aDKm_wDHg2cITI_ljbqU4VRWpwQ7fdgy3c1XcE8,17531
 sxs/juliapkg.json,sha256=higH1UDu30K_PN6-o7lAz0j1xjgYEiCCYBAc-Iaw1Iw,178
 sxs/time_series.py,sha256=OKaLg8tFyrtKcef7900ri-a0C6A8wKxA68KovZXvH6I,41081
@@ -16,11 +16,11 @@ sxs/horizons/xor_multishuffle_bzip2.py,sha256=y4AKuxmLuj8K1pkdhIoSzENGyMu4uhpiPr
 sxs/julia/GWFrames.py,sha256=47H9Ugff7ldGBujiUTcADT3b4MSxUtqmajvSApI91WA,2892
 sxs/julia/__init__.py,sha256=uSLP_xfU-GZG7IO5vs0TEkCR4LH8aBYMF-852wDY3kI,3490
 sxs/metadata/__init__.py,sha256=KCvJ9Cf1WhIZp-z28UzarKcmUAzV2BOv2gqKiorILjo,149
-sxs/metadata/metadata.py,sha256=y6X7LcsJKiZFjBPTwRHGtsT2uHf2s0r0OG_EGjD27pE,27663
+sxs/metadata/metadata.py,sha256=EEax1WTKL4G5U__wHefbBX0l4vtIHTcYFnHwziGkVhM,28348
 sxs/simulations/__init__.py,sha256=GrZym0PHTULDg_hyFmISNzDfqVLz_hQo-djbgecZs54,134
 sxs/simulations/local.py,sha256=CEu8PzumNB1-JA05M4tYSW_UZVrldKzOB5T_I3pFWls,5789
-sxs/simulations/simulation.py,sha256=pSwC82oeoaQTs2TB7uJLl0pScN6b9AgHdmTxf_iRKB4,34161
-sxs/simulations/simulations.py,sha256=YttUK3WTU786OrHKMWya8myuMmmjMbazfIVs7A8FPlk,23781
+sxs/simulations/simulation.py,sha256=OqQh6xq-s_JoQI6e2XA5j194L0DT3HGYIW8ZZiurZ2Y,34631
+sxs/simulations/simulations.py,sha256=ATxrcihvblGgRHdR7vIMg5eKghN5Jo6U0CafTro4wYA,24827
 sxs/utilities/__init__.py,sha256=WSStlqljfgQheMxHGfuofSc5LdmASGvO3FNO3f_zaT0,4806
 sxs/utilities/bitwise.py,sha256=G9ZNYgwDQRhq5wbDf-p2HcUqkEP_IRDiQoXW4KyU17k,13205
 sxs/utilities/dicts.py,sha256=CCpm3upG_9SRj9gjawukSUfaJ5asF-XRG2ausEXhYyg,695
@@ -80,7 +80,7 @@ sxs/zenodo/api/__init__.py,sha256=EM_eh4Q8R5E0vIfMhyIR1IYFfOBu6vA0UTasgX9gHys,21
 sxs/zenodo/api/deposit.py,sha256=J4RGvGjh0cEOrN4bBZWEDcPAhNscqB2fzLlvRZ5HTHM,36948
 sxs/zenodo/api/login.py,sha256=Yz0ytgi81_5BpDzhrS0WPMXlvU2qUaCK8yn8zxfEbko,18007
 sxs/zenodo/api/records.py,sha256=nKkhoHZ95CTztHF9Zzaug5p7IiUCJG4Em1i-l-WqH6U,3689
-sxs-2024.0.28.dist-info/METADATA,sha256=66Nu2saeF56y1gQdN_LuULWiApf-otPsC86HQCSIPGk,9250
-sxs-2024.0.28.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sxs-2024.0.28.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2024.0.28.dist-info/RECORD,,
+sxs-2024.0.30.dist-info/METADATA,sha256=EZmCk2Nq9dYEQJHrhHxkGazpNy8G8_xDlfyLCw5pPSE,9250
+sxs-2024.0.30.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sxs-2024.0.30.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2024.0.30.dist-info/RECORD,,