sxs 2024.0.41__py3-none-any.whl → 2024.0.43__py3-none-any.whl

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2024.0.41"
+__version__ = "2024.0.43"

sxs/handlers.py

@@ -284,7 +284,10 @@ def load(location, download=None, cache=None, progress=None, truepath=None, **kw
             return Simulations.load(
                 download=download,
                 local=kwargs.get("local", False),
-                annex_dir=kwargs.get("annex_dir", None)
+                annex_dir=kwargs.get("annex_dir", None),
+                output_file=kwargs.get("output_file", None),
+                compute_md5=kwargs.get("compute_md5", False),
+                show_progress=kwargs.get("show_progress", False)
             )
 
         elif location == "dataframe":

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/simulations/local.py

@@ -215,12 +215,13 @@ def write_local_simulations(annex_dir, output_file=None, compute_md5=False, show
     simulations = local_simulations(annex_dir, compute_md5=compute_md5, show_progress=show_progress)
 
     # Write the simulations to file
-    if output_file is None:
-        output_file = sxs_directory("cache") / "local_simulations.json"
-    else:
-        output_file = Path(output_file)
-    output_file.parent.mkdir(parents=True, exist_ok=True)
-    with output_file.open("w") as f:
-        dump(simulations, f, indent=2, separators=(",", ": "), ensure_ascii=True)
+    if output_file is not False:  # Test literal identity to allow `None`
+        if output_file is None:
+            output_file = sxs_directory("cache") / "local_simulations.json"
+        else:
+            output_file = Path(output_file)
+        output_file.parent.mkdir(parents=True, exist_ok=True)
+        with output_file.open("w") as f:
+            dump(simulations, f, indent=2, separators=(",", ": "), ensure_ascii=True)
 
     return simulations

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/simulations/simulations.py

@@ -173,7 +173,7 @@ class Simulations(collections.OrderedDict):
         return remote_timestamp
     
     @classmethod
-    def local(cls, directory=None, *, download=None):
+    def local(cls, directory=None, *, download=None, output_file=None, compute_md5=False, show_progress=False):
         """Load the local catalog of SXS simulations
         
         This function loads the standard public catalog, but also
@@ -192,30 +192,47 @@ class Simulations(collections.OrderedDict):
         download : {None, bool}, optional
             Passed to `Simulations.load` when loading the public set
             of simulations.
+        output_file : {None, str, Path}, optional
+            If `directory` is not None, this will be passed to
+            `sxs.write_local_simulations`.
+        compute_md5 : bool, optional
+            If `directory` is not None, this will be passed to
+            `sxs.local_simulations`.
+        show_progress : bool, optional
+            If `directory` is not None, this will be passed to
+            `sxs.local_simulations`.
 
         See Also
         --------
         sxs.local_simulations : Search for local simulations
-        sxs.write_local_simulations : Write local simulations to a file
+        sxs.write_local_simulations : Write local simulations to a
+        file
         
         """
         import json
         from .local import write_local_simulations
         from .. import sxs_directory
 
-        local_path = sxs_directory("cache") / "local_simulations.json"
         if directory is not None:
-            write_local_simulations(directory)
-        if not local_path.exists():
-            if directory is not None:
-                raise ValueError(f"Writing local simulations for {directory=} failed")
-            else:
-                raise ValueError(
-                    f"Local simulations file not found, but no `directory` was provided.\n"
-                    + "If called from `sxs.load`, just pass the name of the directory."
-                )
-        with local_path.open("r") as f:
-            local_simulations = json.load(f)
+            local_path = output_file
+            local_simulations = write_local_simulations(
+                directory,
+                output_file=output_file,
+                compute_md5=compute_md5,
+                show_progress=show_progress
+            )
+        else:
+            local_path = sxs_directory("cache") / "local_simulations.json"
+            if not local_path.exists():
+                if directory is not None:
+                    raise ValueError(f"Writing local simulations for {directory=} failed")
+                else:
+                    raise ValueError(
+                        f"Local simulations file not found, but no `directory` was provided.\n"
+                        + "If called from `sxs.load`, just pass the name of the directory."
+                    )
+            with local_path.open("r") as f:
+                local_simulations = json.load(f)
         simulations = cls.load(download)
         doi_versions = {
             k: v["DOI_versions"]
@@ -229,7 +246,7 @@ class Simulations(collections.OrderedDict):
         return simulations
 
     @classmethod
-    def load(cls, download=None, *, local=False, annex_dir=None):
+    def load(cls, download=None, *, local=False, annex_dir=None, output_file=None, compute_md5=False, show_progress=False):
         """Load the catalog of SXS simulations
 
         Note that — unlike most SXS data files — the simulations file
@@ -263,6 +280,15 @@ class Simulations(collections.OrderedDict):
             If provided and `local=True`, this function will load
             local simulations from the given directory.  This is
             equivalent to calling `Simulations.local(directory)`.
+        output_file : {None, str, Path}, optional
+            If `annex_dir` is not None, this will be passed to
+            `sxs.write_local_simulations`.
+        compute_md5 : bool, optional
+            If `annex_dir` is not None, this will be passed to
+            `sxs.simulations.local_simulations`.
+        show_progress : bool, optional
+            If `annex_dir` is not None, this will be passed to
+            `sxs.simulations.local_simulations`.
 
         See Also
         --------
@@ -280,7 +306,13 @@ class Simulations(collections.OrderedDict):
             return cls._simulations
 
         if local or annex_dir is not None:
-            cls._simulations = cls.local(annex_dir, download=download)
+            cls._simulations = cls.local(
+                annex_dir,
+                download=download,
+                output_file=output_file,
+                compute_md5=compute_md5,
+                show_progress=show_progress
+            )
             return cls._simulations
 
         progress = read_config("download_progress", True)

{sxs-2024.0.41.dist-info → sxs-2024.0.43.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sxs
-Version: 2024.0.41
+Version: 2024.0.43
 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.41.dist-info → sxs-2024.0.43.dist-info}/RECORD

@@ -1,6 +1,6 @@
 sxs/__init__.py,sha256=hbydsXWR88sFiKExPJ1NHWGEvWRbbJBjSc1irSMYKgY,2623
-sxs/__version__.py,sha256=o95yq2nvQ6FsIUfCHrH8nIWlGM_edEB29js8ZcW9LWw,26
-sxs/handlers.py,sha256=Nc1_aDKm_wDHg2cITI_ljbqU4VRWpwQ7fdgy3c1XcE8,17531
+sxs/__version__.py,sha256=2f1GnLIs4eYPdnrJrRDZeA5ovQX_2cfkuPAyFII9GGE,26
+sxs/handlers.py,sha256=o7ihff0glg1DEP95reBZ75lH2h2mP-sZkwUL1_eoMwU,17720
 sxs/juliapkg.json,sha256=-baaa3Za_KBmmiGjlh2YYLWmvUvZl6GaKKXwNI4S7qU,178
 sxs/time_series.py,sha256=OKaLg8tFyrtKcef7900ri-a0C6A8wKxA68KovZXvH6I,41081
 sxs/caltechdata/__init__.py,sha256=pvyc2Djch4DA6t06op-0NSTegrMSywzNi7Z3W_91-Cg,14670
@@ -17,11 +17,11 @@ sxs/julia/GWFrames.py,sha256=47H9Ugff7ldGBujiUTcADT3b4MSxUtqmajvSApI91WA,2892
 sxs/julia/__init__.py,sha256=uSLP_xfU-GZG7IO5vs0TEkCR4LH8aBYMF-852wDY3kI,3490
 sxs/metadata/__init__.py,sha256=jz0A3sBYQoNVZ5sdHv6LgI6y4kP2051-esCR62xt6bM,184
 sxs/metadata/metadata.py,sha256=vqzNufg46BrbFAuvDF55JvrQc0ZIBxSG4eH2awv5PDs,28610
-sxs/metadata/metric.py,sha256=zWyM23SQUMXwpDvQNnp2USJrwxiC3SoobFXm0h_sMMs,6615
+sxs/metadata/metric.py,sha256=W_PMNmsJ2qBjIeAll4TgUz79-SZkiBTswTfK4gKWrPU,6785
 sxs/simulations/__init__.py,sha256=GrZym0PHTULDg_hyFmISNzDfqVLz_hQo-djbgecZs54,134
-sxs/simulations/local.py,sha256=kyFvlw9CywlyBy0H2GiSgOp4M7Uq31Db5LIdd2do43M,8242
-sxs/simulations/simulation.py,sha256=HRm6vaVGjRziQZ1VPOG1ESxaITgLAJCp4lhGZ4fpez8,36232
-sxs/simulations/simulations.py,sha256=xP1ljseDSkfs6_u25-DnSNlFQtQexiP25Kwtm7nWdsE,23910
+sxs/simulations/local.py,sha256=nfca2cG3LWNC8Jc-i79BZmKdwPfhPgPKja-wXg_qEKw,8344
+sxs/simulations/simulation.py,sha256=lVA2aSRy4-V1-1bFE74zIN8Tpvf7QDtn9n7xmR7oqcU,37579
+sxs/simulations/simulations.py,sha256=5OYQez3BXtg8zbCe85MlSqYtAKv4UqXt7iRfLiPAWxw,25367
 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
@@ -82,7 +82,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.41.dist-info/METADATA,sha256=IUvgoHcgUjDEQ3GRq__ZTr7Dn5n9kYi8EFtr-tOpRKM,9253
-sxs-2024.0.41.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sxs-2024.0.41.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2024.0.41.dist-info/RECORD,,
+sxs-2024.0.43.dist-info/METADATA,sha256=5rmhF6Twj0ZjJtLFM6_zmtlccn4mJ0dDK78wh5CJaNM,9253
+sxs-2024.0.43.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sxs-2024.0.43.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2024.0.43.dist-info/RECORD,,