sxs 2024.0.40__tar.gz → 2024.0.42__tar.gz

{sxs-2024.0.40 → sxs-2024.0.42}/CITATION.cff

@@ -10,5 +10,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2024.0.40
-date-released: 2025-02-24
+version: 2024.0.42
+date-released: 2025-03-03

{sxs-2024.0.40 → sxs-2024.0.42}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sxs
-Version: 2024.0.40
+Version: 2024.0.42
 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.42/sxs/__version__.py

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

{sxs-2024.0.40 → sxs-2024.0.42}/sxs/metadata/metadata.py

@@ -2,6 +2,7 @@
 
 import re
 import collections
+import numpy as np
 
 
 _valid_identifier_pattern = re.compile(r'\W|^(?=\d)')
@@ -29,8 +30,11 @@ def _backwards_compatibility(metadata):
     # 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"]
+    if "number_of_orbits" not in metadata:
+        if "number_of_orbits_from_start" in metadata:
+            metadata["number_of_orbits"] = metadata["number_of_orbits_from_start"]
+        else:
+            metadata["number_of_orbits"] = np.nan
     return metadata
 
 

{sxs-2024.0.40 → sxs-2024.0.42}/sxs/metadata/metric.py

@@ -14,6 +14,9 @@ class MetadataMetric:
     metadata, rather than as a strict metric for clustering or
     classification.
 
+    Note that calling an object of this class with two metadata
+    collections will return the *squared* distance between them.
+
     Parameters
     ----------
     parameters : list of str, optional
@@ -60,13 +63,14 @@ class MetadataMetric:
     def __init__(
             self,
             parameters=[
-                "reference_mass_ratio",
+                "reference_mass1",
+                "reference_mass2",
                 "reference_dimensionless_spin1",
                 "reference_dimensionless_spin2",
                 "reference_eccentricity",
                 "reference_mean_anomaly",
             ],
-            metric=np.diag([1, 1, 1, 1, 1, 1, 1, 1, 1/np.pi**2]),
+            metric=np.diag([1, 1, 1, 1, 1, 1, 1, 1, 1, 1/np.pi**2]),
             allow_different_object_types=False,
             eccentricity_threshold1=1e-2,
             eccentricity_threshold2=1e-3,
@@ -113,7 +117,7 @@ class MetadataMetric:
             values1[i], values2[i] = np.unwrap([floater(values1[i]), floater(values2[i])])
 
         if "reference_eccentricity" in self.parameters:
-            # Either way, we first make sure that the corresponding entries are floats.
+            # Either way, we first try to make sure that the corresponding entries are floats.
             i = self.parameters.index("reference_eccentricity")
             values1[i] = metadata1.get("reference_eccentricity_bound", floaterbound(values1[i]))
             values2[i] = metadata2.get("reference_eccentricity_bound", floaterbound(values2[i]))

{sxs-2024.0.40 → sxs-2024.0.42}/sxs/simulations/local.py

@@ -153,7 +153,14 @@ def local_simulations(annex_dir, compute_md5=False, show_progress=False):
                 files = files_to_upload(dirpath, annex_dir)
 
                 metadata["mtime"] = datetime.fromtimestamp(
-                    max(file.resolve().stat().st_mtime for file in files),
+                    max(
+                        (
+                            file.resolve().stat().st_mtime
+                            for file in files
+                            if file.exists()
+                        ),
+                        default=0.0,
+                    ),
                     tz=timezone.utc,
                 ).isoformat()
 
@@ -164,6 +171,7 @@ def local_simulations(annex_dir, compute_md5=False, show_progress=False):
                         "checksum": md5checksum(file) if compute_md5 else "",
                     }
                     for file in files
+                    if file.exists()
                 }
             except KeyboardInterrupt:
                 raise

{sxs-2024.0.40 → sxs-2024.0.42}/sxs/simulations/simulation.py

@@ -59,13 +59,14 @@ def Simulation(location, *args, **kwargs):
         If `True`, completely bypass checking for deprecation or
         supersession.  No warnings or errors will be issued.  Default
         is `False`.
-    auto_supersede : bool, optional
-        If `True`, automatically load the superseding simulation, if
-        there is only one.  If there are multiple superseding
-        simulations, an error will be raised, and you must explicitly
-        choose one.  If there is only one, a warning will still be
-        issued, but the superseding simulation will be loaded.  Note
-        that this can also be set in the configuration file with
+    auto_supersede : bool or float, optional
+        If present, automatically load the closest undeprecated
+        simulation.  If this is a float and the distance to the
+        closest undeprecated simulation (see the following argument)
+        is larger, a ValueError will be raised.  Otherwise, a warning
+        will be issued with the ID of the new simulation and the
+        distance.  Note that this can also be set in the configuration
+        file by calling, e.g.,
         `sxs.write_config(auto_supersede=True)`.
     metadata_metric : MetadataMetric, optional
         Metric to use for comparing simulations when automatically
@@ -147,8 +148,9 @@ def Simulation(location, *args, **kwargs):
                     f"Simulation '{location}' is deprecated.  You could\n"
                     +  "  1. pass `ignore_deprecation=True` to load the latest available version,\n"
                     +  "  2. manually choose a different simulation from the catalog,\n"
-                    +  "  3. pass `auto_supersede=True` to load the closest match in the catalog, or\n"
-                    + f"  4. include the version number, as in '{sxs_id_stem}v2.0', to load a specific version.\n"
+                    +  "  3. pass `auto_supersede=0.01` to load a match closer than 0.01 in the catalog if one exists,\n"
+                    +  "  4. pass `auto_supersede=True` to load the closest match in the catalog, or\n"
+                    + f"  5. include the version number, as in '{sxs_id_stem}v2.0', to load a specific version.\n"
                 )
             else:
                 message = ("\n"
@@ -170,11 +172,25 @@ def Simulation(location, *args, **kwargs):
                 original_kwargs["ignore_deprecation"] = True
                 original = Simulation(location, *args, **original_kwargs)
                 metadata_metric = kwargs.pop("metadata_metric", MetadataMetric())
-                superseding = original.closest_simulation(
+                superseding, distance = original.closest_simulation(
                     dataframe=simulations.dataframe,
                     metadata_metric=metadata_metric
                 )
-                message = f"\nSimulation '{sxs_id}' is being automatically superseded by '{superseding}'."
+                if isinstance(auto_supersede, str):
+                    try:
+                        auto_supersede = float(auto_supersede)
+                    except:
+                        pass
+                if isinstance(auto_supersede, float) and distance > auto_supersede:
+                    raise ValueError(
+                        f"Simulation '{sxs_id}' is deprecated, but the closest undeprecated\n"
+                        f"simulation is more distant than allowed by `auto_supersede` argument:\n"
+                        f"{distance:.3g} > {auto_supersede:.3g}.\n"
+                    )
+                message = (
+                    f"\nSimulation '{sxs_id}' is being automatically superseded by '{superseding}'."
+                    f"\nThe distance between them in the given metadata metric is {distance:.3g}."
+                )
                 warn(message)
                 new_location = f"{superseding}{input_version}"
                 if input_lev_number:
@@ -342,6 +358,7 @@ class SimulationBase:
             metadata
 
         """
+        from numpy import sqrt
         from ..metadata.metric import MetadataMetric
         from .. import load
         if dataframe is None:
@@ -350,11 +367,11 @@ class SimulationBase:
         if drop_deprecated:
             dataframe = dataframe[~dataframe.deprecated]
         return dataframe.apply(
-            lambda m: metadata_metric(self.metadata, m),
+            lambda m: sqrt(metadata_metric(self.metadata, m)),
             axis=1
         )
 
-    def closest_simulation(self, dataframe=None, metadata_metric=None):
+    def closest_simulation(self, dataframe=None, metadata_metric=None, warning_threshold=1e-2):
         """Return the closest undeprecated simulation to this one
 
         Note that any simulation in `dataframe` with zero distance
@@ -370,12 +387,17 @@ class SimulationBase:
         metadata_metric : MetadataMetric, optional
             Metric to use for comparing simulations.  If not provided,
             the default metric will be used.
+        warning_threshold : float, optional
+            Threshold distance above which a warning will be issued
+            that the closest simulation is fairly distant.  Default is
+            1e-3.
 
         Returns
         -------
         closest_index : str
             Index of the closest undeprecated simulation in the
             `dataframe`.
+        distance : float
 
         """
         d = self.distances(
@@ -384,7 +406,9 @@ class SimulationBase:
             drop_deprecated=True
         )
         d = d[d > 0].sort_values()
-        return d.index[0]
+        if d.iloc[0] > warning_threshold:
+            warn(f"\nClosest simulation ({d.index[0]}) is fairly distant: {d.iloc[0]:.3g}")
+        return d.index[0], d.iloc[0]
     
     @property
     def dataframe(self):

sxs-2024.0.40/sxs/__version__.py

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