sxs 2025.0.7__py3-none-any.whl → 2025.0.9__py3-none-any.whl

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2025.0.7"
+__version__ = "2025.0.9"

sxs/simulations/analyze.py

@@ -1,3 +1,5 @@
+import os
+import json
 import multiprocessing
 
 from ..waveforms.norms import create_unified_waveforms, L2_difference, mismatch
@@ -7,7 +9,7 @@ from ..handlers import load
 import numpy as np
 
 
-def compute_error_summary(wa, wb, t1, t2, modes=None, ASDs=None, total_masses=None):
+def compute_error_summary(wa, wb, t1, t2, modes=None, ASDs_and_total_masses=None):
     """
     Compute various errors between two waveforms.
 
@@ -27,12 +29,13 @@ def compute_error_summary(wa, wb, t1, t2, modes=None, ASDs=None, total_masses=No
     modes : list, optional
         Modes (ell, m) to include in error calculations.
         Default is all modes.
-    ASDs : dict of funcs, optional
-        Dictionary of functions mapping frequencies to the ASD of a detector(s).
+    ASDs_and_total_masses : dict of funcs, optional
+        Dictionary of functions mapping frequencies to the ASD of a detector(s)
+        and total masses to use for mismatch calculations with those ASDs, e.g.,
+        {
+            'CE': [CE_ASD, total_masses]
+        }
         Default is no frequency-domain mismatch is calculated.
-    total_masses : list of floats, optional
-        Total masses in solar masses to use for frequency-domain mismatches.
-        Default is 1.
 
     Returns
     -------
@@ -65,10 +68,8 @@ def compute_error_summary(wa, wb, t1, t2, modes=None, ASDs=None, total_masses=No
 
     wa_tilde = wa.fourier_transform()
     wb_tilde = wb.fourier_transform()
-    if ASDs is not None:
-        if total_masses is None:
-            raise ValueError("Need to specify total masses if ASDs are provided.")
-        for ASD in ASDs:
+    if ASDs_and_total_masses is not None:
+        for ASD_name, (ASD_data, total_masses) in ASDs_and_total_masses.items():
             for total_mass in total_masses:
                 # Note that we only need to make the frequency unitful, since the
                 # magnitude of the strain scales out in the mismatch.
@@ -82,8 +83,8 @@ def compute_error_summary(wa, wb, t1, t2, modes=None, ASDs=None, total_masses=No
                 wa_tilde_total_mass.t = wa_tilde_total_mass.t * frequency_factor
                 wb_tilde_total_mass.t = wb_tilde_total_mass.t * frequency_factor
 
-                errors[f"mismatch {ASD} {total_mass}"] = mismatch(
-                    wa_tilde_total_mass, wb_tilde_total_mass, f1 * frequency_factor, modes=modes, ASD=ASDs[ASD]
+                errors[f"mismatch {ASD_name} {total_mass}"] = mismatch(
+                    wa_tilde_total_mass, wb_tilde_total_mass, f1 * frequency_factor, modes=modes, ASD=ASD_data
                 )
 
     ell_min = max(wa.ell_min, wb.ell_min)
@@ -104,8 +105,8 @@ def analyze_simulation(
     analyze_levs=True,
     analyze_extrapolation=True,
     analyze_psi4=True,
-    ASDs=None,
-    total_masses=None,
+    ASDs_and_total_masses=None,
+    path_to_analysis_cache=None,
     nprocs=None,
 ):
     """
@@ -134,12 +135,13 @@ def analyze_simulation(
     analyze_psi4 : bool, optional
         Whether or not to analyze the psi4 constraint -h.ddot = psi4..
         Default is True.
-    ASDs : dict of funcs, optional
-        Dictionary of functions mapping frequencies to the ASD of a detector(s).
+    ASDs_and_total_masses : dict of funcs, optional
+        Dictionary of functions mapping frequencies to the ASD of a detector(s)
+        and total masses to use for mismatch calculations with those ASDs, e.g.,
+        {
+            'CE': [CE_ASD, total_masses]
+        }
         Default is no frequency-domain mismatch is calculated.
-    total_masses : list of floats, optional
-        Total masses in solar masses to use for frequency-domain mismatches.
-        Default is 1.
     nprocs : int, optional
         Number of cpus to use.  Default is maximum number.  If -1 is provided,
         then no multiprocessing is performed.
@@ -154,23 +156,23 @@ def analyze_simulation(
     sim = load(sim_name)
 
     # Lev analysis
-    if analyze_levs:
-        for i, lev in enumerate(sim.lev_numbers[1:][::-1]):
-            sim_low_lev = load(f"{sim_name}/Lev{lev - 1}")
-            sim_high_lev = load(f"{sim_name}/Lev{lev}")
+    if analyze_levs and len(sim.lev_numbers) > 1:
+        for i, (low_lev, high_lev) in enumerate(zip(sim.lev_numbers[:-1][::-1], sim.lev_numbers[1:][::-1])):
+            sim_low_lev = load(f"{sim_name}/Lev{low_lev}")
+            sim_high_lev = load(f"{sim_name}/Lev{high_lev}")
 
             w_high_lev = sim_high_lev.h
             if i == 0:
                 w_low_lev_prime, transformation, L2_norm, t1, t2 = align_simulations(
                     sim_low_lev, sim_high_lev, alignment_method="4d", nprocs=nprocs
                 )
-                errors[f"(Lev{lev - 1}, Lev{lev}) 4d"] = compute_error_summary(w_low_lev_prime, w_high_lev, t1, t2)
-                errors[f"(Lev{lev - 1}, Lev{lev}) 4d transformation"] = transformation
+                errors[f"(Lev{low_lev}, Lev{high_lev}) 4d"] = compute_error_summary(w_low_lev_prime, w_high_lev, t1, t2, ASDs_and_total_masses=ASDs_and_total_masses)
+                errors[f"(Lev{low_lev}, Lev{high_lev}) 4d transformation"] = transformation
 
             w_low_lev_prime, transformation, _, t1, t2 = align_simulations(
                 sim_low_lev, sim_high_lev, alignment_method="independent alignment", nprocs=nprocs
             )
-            errors[f"(Lev{lev - 1}, Lev{lev})"] = L2_difference(w_high_lev, w_low_lev_prime, t1, t2)
+            errors[f"(Lev{low_lev}, Lev{high_lev})"] = L2_difference(w_high_lev, w_low_lev_prime, t1, t2)
 
     # Extrapolation order analysis
     if analyze_extrapolation:
@@ -179,7 +181,7 @@ def analyze_simulation(
 
             w_n2 = sim.h
             w_other = other.h
-
+                            
             t1 = sim.metadata.relaxation_time
 
             w_other_prime, transformation, _, t1, t2 = align_waveforms(
@@ -202,6 +204,26 @@ def analyze_simulation(
 
         errors[f"(-h.ddot, psi4)"] = L2_norm
 
+    if path_to_analysis_cache is not None:
+        if not os.path.exists(path_to_analysis_cache):
+            os.makedirs(path_to_analysis_cache)
+
+        def default(obj):
+            if isinstance(obj, np.ndarray):
+                return obj.tolist()
+            raise TypeError("Not serializable")
+
+        sim_name = sim_name.replace(':','_')
+        with open(f"{path_to_analysis_cache}/{sim_name}.json", "w") as output_file:
+            json.dump(
+                errors,
+                output_file,
+                indent=2,
+                separators=(",", ": "),
+                ensure_ascii=True,
+                default=default,
+            )
+
     return errors
 
 
@@ -210,8 +232,8 @@ def analyze_simulations(
     analyze_levs=True,
     analyze_extrapolation=True,
     analyze_psi4=True,
-    ASDs=None,
-    total_masses=None,
+    ASDs_and_total_masses=None,
+    path_to_analysis_cache=None,
     nprocs=None,
 ):
     """
@@ -240,12 +262,17 @@ def analyze_simulations(
     analyze_psi4 : bool, optional
         Whether or not to analyze the psi4 constraint -h.ddot = psi4..
         Default is True.
-    ASDs : dict of funcs, optional
-        Dictionary of functions mapping frequencies to the ASD of a detector(s).
+    ASDs_and_total_masses : dict of funcs, optional
+        Dictionary of functions mapping frequencies to the ASD of a detector(s)
+        and total masses to use for mismatch calculations with those ASDs, e.g.,
+        {
+            'CE': [CE_ASD, total_masses]
+        }
         Default is no frequency-domain mismatch is calculated.
-    total_masses : list of floats, optional
-        Total masses in solar masses to use for frequency-domain mismatches.
-        Default is 1.
+    path_to_analysis_cache : str, optional
+        Path to directory to cache indvidual simulation analyses.
+        If None, no caching is performed.
+        Default is no cashing is performed.
     nprocs : int, optional
         Number of cpus to use.  Default is maximum number.  If -1 is provided,
         then no multiprocessing is performed.
@@ -254,14 +281,14 @@ def analyze_simulations(
     -------
     errors : dict
         Dictionary of the errors described above.
-    """
+    """ 
     errors = {}
     if nprocs != -1:
         with multiprocessing.Pool(processes=nprocs) as pool:
             results = pool.starmap(
                 analyze_simulation,
                 [
-                    (sim_name, analyze_levs, analyze_extrapolation, analyze_psi4, ASDs, total_masses, -1)
+                    (sim_name, analyze_levs, analyze_extrapolation, analyze_psi4, ASDs_and_total_masses, path_to_analysis_cache, -1)
                     for sim_name in sim_names
                 ],
             )
@@ -270,7 +297,7 @@ def analyze_simulations(
     else:
         for sim_name in sim_names:
             errors[sim_name] = analyze_simulation(
-                sim_name, analyze_levs, analyze_extrapolation, analyze_psi4, ASDs, total_masses, -1
+                sim_name, analyze_levs, analyze_extrapolation, analyze_psi4, ASDs_and_total_masses, path_to_analysis_cache, -1
             )
 
     return errors

sxs/simulations/simulation.py

@@ -233,7 +233,7 @@ def Simulation(location, *args, **kwargs):
                 )
                 warn(message)
                 new_location = f"{superseding}{input_version}"
-                if input_lev_number:
+                if input_lev_number is not None:
                     new_location += f"/Lev{input_lev_number}"
                 return Simulation(new_location, *args, **kwargs)
 
@@ -250,7 +250,7 @@ def Simulation(location, *args, **kwargs):
     # If Lev is given as part of `location`, use it; otherwise, use the highest available
     lev_numbers = metadata.get(
         "lev_numbers",
-        sorted({lev_num for f in metadata.get("files", []) if (lev_num:=lev_number(f))})
+        sorted({lev_num for f in metadata.get("files", []) if (lev_num:=lev_number(f)) is not None})
     )
     if not lev_numbers:
         raise ValueError(f"Could not find Levs for {location}")
@@ -259,7 +259,10 @@ def Simulation(location, *args, **kwargs):
             f"Lev number '{input_lev_number}' not found in simulation files for {sxs_id}"
         )
     max_lev_number = max(lev_numbers)
-    output_lev_number = input_lev_number or max_lev_number
+    if input_lev_number is not None:
+        output_lev_number = input_lev_number
+    else:
+        output_lev_number = max_lev_number
     if output_lev_number is None:
         raise ValueError(
             f"No Lev number found for {location}"
@@ -270,7 +273,7 @@ def Simulation(location, *args, **kwargs):
     # or a less-than-maximal Lev
     if (
         version_is_not_default
-        or (lev_numbers and output_lev_number != max_lev_number)
+        or output_lev_number != max_lev_number
     ):
         metadata = None
 

sxs/waveforms/alignment.py

@@ -838,7 +838,10 @@ def align_simulations(
 
     if t1 is None:
         # Default to reference time
-        t1 = simb.metadata.reference_time
+        t1 = max(
+            sima.metadata.reference_time,
+            simb.metadata.reference_time
+        )
 
     wa_prime, transformation, L2_norm, t1, t2 = align_waveforms(
         sima.h,

sxs/waveforms/memory.py

@@ -13,6 +13,7 @@ h_with_memory = sxs.waveforms.memory.add_memory(h, integration_start_time=1000.0
 """
 
 import numpy as np
+from . import WaveformModes
 from . import waveform_mts
 
 

{sxs-2025.0.7.dist-info → sxs-2025.0.9.dist-info}/METADATA

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

@@ -1,5 +1,5 @@
 sxs/__init__.py,sha256=8PntABL6yx7Ad70hP7WedNAVDTZiwm_2At5xIQGo4k8,2610
-sxs/__version__.py,sha256=Sb83Pr0X5dxDLb6m-eW2IPmwgSbc6jBC6oTrW8sZwRE,25
+sxs/__version__.py,sha256=bJ1sZ9oROn9G9ZDBWzG6wiJYNXAEycXq6KeuuangpJc,25
 sxs/handlers.py,sha256=jVV-HK-omzoBx5N2wcpLHvyoWq86hUfWCjnGbPpD91I,18343
 sxs/juliapkg.json,sha256=-baaa3Za_KBmmiGjlh2YYLWmvUvZl6GaKKXwNI4S7qU,178
 sxs/time_series.py,sha256=OKaLg8tFyrtKcef7900ri-a0C6A8wKxA68KovZXvH6I,41081
@@ -16,9 +16,9 @@ sxs/metadata/__init__.py,sha256=vEb633hoKAnI9O7kBtejZXFFsWM6h_ShuTq2_Xl3hUs,72
 sxs/metadata/metadata.py,sha256=8LBDWeUAtLOP-MTqbwf_m5eb6k8UKj0L_yKthidF7lA,98
 sxs/metadata/metric.py,sha256=Tsig1Jm50OO8r89zfjCuQ4i3JAoiazSb4J9qYtPWKgM,41
 sxs/simulations/__init__.py,sha256=eXkheYhRaYyKjul5J1IXpoJ7Wq4nr3Tgwr-HSS3BTek,156
-sxs/simulations/analyze.py,sha256=RaImREx3fWlXgJRCI-Wsq0-LjidL-Mb8SIN3-n-TMqM,10373
+sxs/simulations/analyze.py,sha256=YwX0i_GRATRpvp7T8VheShkclvqYsraGDDKEkJQxJnw,11530
 sxs/simulations/local.py,sha256=e77SeaWMl2PWX_EndQtShOXZxcFKhQsUDQ55R2Njcuc,43
-sxs/simulations/simulation.py,sha256=tzI1s15mU1CDdst7XZRD4UehtbkRvIao16ONTAA0zfI,42353
+sxs/simulations/simulation.py,sha256=8PJOyvC901XYzY1adPqrP-zpfVHYm8AsuHWx-FoREWo,42435
 sxs/simulations/simulations.py,sha256=sMle89VoD1CQni1N23Vjo3h2yj9LHHAtuaB_qfD3Wgg,109
 sxs/utilities/__init__.py,sha256=WSStlqljfgQheMxHGfuofSc5LdmASGvO3FNO3f_zaT0,4806
 sxs/utilities/bitwise.py,sha256=G9ZNYgwDQRhq5wbDf-p2HcUqkEP_IRDiQoXW4KyU17k,13205
@@ -56,8 +56,8 @@ sxs/utilities/references/inspire.py,sha256=kDjY-UFJT-VTS3yJOT8fT6LJG-pRrX9TK8nv3
 sxs/utilities/references/journal_abbreviations.py,sha256=SuRXcr4rv9YPbXD4mzujSvE7M6KS1lwELimuyn7mfCE,31018
 sxs/utilities/references/references.py,sha256=29rPUZKw3dztXQLRDEt1hGYjZaONFd0qX--xQxzOmUU,418
 sxs/waveforms/__init__.py,sha256=yfPzExhZZqNrPOe784f8BC8mHUiwb85urKM_4_pzUFo,1157
-sxs/waveforms/alignment.py,sha256=TYSsGq3dRQwoookyzkNkT02pGViPC0TqQ64RksX4OxU,32649
-sxs/waveforms/memory.py,sha256=zuph5JgeBog6xrCbcSYzXegPfUtoPUXnYmmY5KfYUj8,7272
+sxs/waveforms/alignment.py,sha256=vFa58ZgdMTFam-LFQ47xo0iBjfiiFaGIaN1kE5kpjSk,32718
+sxs/waveforms/memory.py,sha256=UR2NLMyS0TLJ-2ntdKdzQ00Ot4OvBDrlX6lhFM_uPtI,7300
 sxs/waveforms/mode_utilities.py,sha256=gxsW-hunCoIReBVv9IrkGLdshr0rmztbH-JRgD6D9z0,5253
 sxs/waveforms/norms.py,sha256=zemgJsWNhng3QAi3ixHAZ8P5SSIUcHysSQIcqRGDeyI,8944
 sxs/waveforms/transformations.py,sha256=S5C-xnCk2umZlVsYgciyp7VMGZA8NI6md7OZp72upJU,9124
@@ -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-2025.0.7.dist-info/METADATA,sha256=7S6sizUf1CMLH-B7rsbjpX1rbYTeeJ-0FlClcR07ct0,9311
-sxs-2025.0.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sxs-2025.0.7.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2025.0.7.dist-info/RECORD,,
+sxs-2025.0.9.dist-info/METADATA,sha256=6x201xfU_VJBuOrRmF6zYuzpJHrh5iWn_hb5s_lPqAY,9311
+sxs-2025.0.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sxs-2025.0.9.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2025.0.9.dist-info/RECORD,,