sxs 2023.1.3__py3-none-any.whl → 2023.1.4__py3-none-any.whl

sxs/__version__.py

@@ -1 +1 @@
-__version__ = "2023.1.3"
+__version__ = "2023.1.4"

sxs/julia/GWFrames.py

@@ -0,0 +1,73 @@
+import quaternionic
+from .. import WaveformModes
+from . import PostNewtonian
+
+def PNWaveform(
+    Approximant, delta, chi1_i, chi2_i, Omega_orb_i, *,
+    Omega_orb_0=None, R_frame_i=None, MinStepsPerOrbit=32,
+    PNWaveformModeOrder=4.0, PNOrbitalEvolutionOrder=4.0,
+    inertial=False, dt=0.0, quiet=True,
+    ell_min=2, ell_max=8, Lambda1=0, Lambda2=0,
+    **kwargs
+):
+    """Generate a PN waveform.
+
+    The return value is an `sxs.WaveformModes` object with the
+    following additional fields:
+
+        - `M1` (array): The primary mass as a function of time.
+        - `M2` (array): The secondary mass as a function of time.
+        - `chi1` (array): The primary spin as a function of time.
+        - `chi2` (array): The secondary spin as a function of time.
+        - `frame` (array): The quaternionic frame as a function of
+          time.
+        - `v` (array): The orbital velocity as a function of time.
+        - `orbital_phase` (array): The orbital phase as a function of
+          time.
+    
+    This is a wrapper around the Julia function
+    `PostNewtonian.GWFrames.PNWaveform`.  See [the Julia
+    documentation](https://moble.github.io/PostNewtonian.jl/dev/interface/gwframes/#PostNewtonian.GWFrames.PNWaveform)
+    for details on the optional keyword arguments.
+    
+    """
+    Omega_orb_0 = Omega_orb_0 or Omega_orb_i
+    R_frame_i = R_frame_i or [1.0]
+
+    # Integrate the orbital dynamics
+    w1 = PostNewtonian.GWFrames.PNWaveform(
+        Approximant, delta, chi1_i, chi2_i, Omega_orb_i,
+        Omega_orb_0=Omega_orb_0, R_frame_i=R_frame_i,
+        MinStepsPerOrbit=MinStepsPerOrbit,
+        PNWaveformModeOrder=PNWaveformModeOrder,
+        PNOrbitalEvolutionOrder=PNOrbitalEvolutionOrder,
+        inertial=inertial, dt=dt, quiet=quiet,
+        ell_min=ell_min, ell_max=ell_max, Lambda1=Lambda1, Lambda2=Lambda2,
+        **kwargs
+    )
+
+    w = WaveformModes(
+        w1.data,
+        time=w1.t,
+        modes_axis=1,
+        ell_min=2,
+        ell_max=8,
+        M1=w1.M1.to_numpy(),
+        M2=w1.M2.to_numpy(),
+        chi1=w1.chi1.to_numpy(),
+        chi2=w1.chi2.to_numpy(),
+        frame=quaternionic.array(w1.frame.to_numpy()),
+        v=w1.v.to_numpy(),
+        orbital_phase=w1.Phi.to_numpy(),
+    )
+
+    # Allow the extra fields to be accessed naturally
+    w.M1 = w._metadata["M1"]
+    w.M2 = w._metadata["M2"]
+    w.chi1 = w._metadata["chi1"]
+    w.chi2 = w._metadata["chi2"]
+    #w.frame = w._metadata["frame"]  ## Already done
+    w.v = w._metadata["v"]
+    w.orbital_phase = w._metadata["orbital_phase"]
+
+    return w

sxs/julia/__init__.py

@@ -6,7 +6,7 @@ import juliacall
 
 PostNewtonian = juliacall.newmodule("PN")
 PostNewtonian.seval("using PostNewtonian")
-
+GWFrames = PostNewtonian.GWFrames
 
 def pkg_update():
     """Update all installed Julia packages (but not julia itself)."""
@@ -16,6 +16,18 @@ def pkg_update():
 
 def PNWaveform(M1, M2, chi1, chi2, Omega_i, **kwargs):
     """Generate a PN waveform.
+
+    The return value is an `sxs.WaveformModes` object with the
+    following additional fields:
+
+        - `M1` (array): The primary mass as a function of time.
+        - `M2` (array): The secondary mass as a function of time.
+        - `chi1` (array): The primary spin as a function of time.
+        - `chi2` (array): The secondary spin as a function of time.
+        - `frame` (array): The quaternionic frame as a function of time.
+        - `v` (array): The orbital velocity as a function of time.
+        - `orbital_phase` (array): The orbital phase as a function of
+          time.
     
     This is a wrapper around the Julia functions
     `PostNewtonian.orbital_evolution` and
@@ -26,6 +38,7 @@ def PNWaveform(M1, M2, chi1, chi2, Omega_i, **kwargs):
     """
     # Integrate the orbital dynamics
     inspiral = PostNewtonian.orbital_evolution(M1, M2, chi1, chi2, Omega_i, **kwargs)
+    values = PostNewtonian.stack(inspiral.u)
 
     # Compute the waveform in the inertial frame
     h = PostNewtonian.inertial_waveform(inspiral).to_numpy().T
@@ -36,13 +49,13 @@ def PNWaveform(M1, M2, chi1, chi2, Omega_i, **kwargs):
         modes_axis=1,
         ell_min=2,
         ell_max=8,
-        M1=inspiral[0, :].to_numpy(),
-        M2=inspiral[1, :].to_numpy(),
-        chi1=inspiral[2:5, :].to_numpy().T,
-        chi2=inspiral[5:8, :].to_numpy().T,
-        frame=quaternionic.array(inspiral[8:12, :].to_numpy().T),
-        v=inspiral[12, :].to_numpy(),
-        orbital_phase=inspiral[13, :].to_numpy(),
+        M1=values[0, :].to_numpy(),
+        M2=values[1, :].to_numpy(),
+        chi1=values[2:5, :].to_numpy().T,
+        chi2=values[5:8, :].to_numpy().T,
+        frame=quaternionic.array(values[8:12, :].to_numpy().T),
+        v=values[12, :].to_numpy(),
+        orbital_phase=values[13, :].to_numpy(),
     )
 
     # Allow the extra fields to be accessed naturally

sxs/juliapkg.json

@@ -1,5 +1,5 @@
 {
-    "julia": "1.6",
+    "julia": "1.9",
     "packages": {
         "PostNewtonian": {
             "uuid": "377afc40-5642-4616-8613-b7ebca523866",

{sxs-2023.1.3.dist-info → sxs-2023.1.4.dist-info}/METADATA

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

@@ -1,7 +1,7 @@
 sxs/__init__.py,sha256=mDh2J6wLpie1GJT-Z3cmB3poEOvjXk-JsRu-p9U7zlI,2512
-sxs/__version__.py,sha256=OeJQQXYYnYEBGpOBxLoCsxaBHe2dYtWJXMEq3bMjGvE,25
+sxs/__version__.py,sha256=s21Xu-A9006ckoa-4vNKxe4sO6GhwdzjLuv_1fbzOvk,25
 sxs/handlers.py,sha256=odBzrk5f-Q3Nzm2_brKBGiSgo-x8q4DmCt0H0E6J8Ko,20929
-sxs/juliapkg.json,sha256=w2uj6N7NueJ_kV7FCjQARJw1M7UVdwqRu9MvqGAc-GU,176
+sxs/juliapkg.json,sha256=7gFXwLT2iVnQp9280M2WLj4uVgWHiNy1qixQK17BSqw,176
 sxs/time_series.py,sha256=c3doMFyRrC33_YjFO4CLGhBOECWECo4TGzrhetSG8EQ,39641
 sxs/caltechdata/__init__.py,sha256=s-RXyBiImKsQenqJIU6NAjlsjOX7f1MkIIW9rPtWYyg,14761
 sxs/caltechdata/catalog.py,sha256=E2nystCaMZLKxTlLgfbfpGkckfkLyIzhn3YeEI3nQYc,4914
@@ -13,7 +13,8 @@ sxs/catalog/description.py,sha256=4eHMde4oGNp69jRmXCsfrIYJ4WK5HYgYFgXyF5htLDM,10
 sxs/horizons/__init__.py,sha256=KR0aaEyreLHJItMBExGhG8bhRrHfPc0jBgPMsHysoEY,16265
 sxs/horizons/spec_horizons_h5.py,sha256=63cIGXuCEbJWrkRu3_mjL2gmssWtQ4axBTmg_wo_020,3642
 sxs/horizons/xor_multishuffle_bzip2.py,sha256=y4AKuxmLuj8K1pkdhIoSzENGyMu4uhpiPrBh-XisvK4,6536
-sxs/julia/__init__.py,sha256=2zw5QhsiDbDnpwnE581mwttDszxF7hd5y617Iy0elpU,1753
+sxs/julia/GWFrames.py,sha256=WIm6TKm_2crM4TDY098XOKZVccUDzN8ndDN5RrG9eHI,2558
+sxs/julia/__init__.py,sha256=mu_hVj7YjXAPrzqb7W0bM-aWA9rawsVobX-6nabISTs,2405
 sxs/metadata/__init__.py,sha256=KCvJ9Cf1WhIZp-z28UzarKcmUAzV2BOv2gqKiorILjo,149
 sxs/metadata/metadata.py,sha256=_vGqMUbeiN0fecJj9f9f9ex56WgSZuwwBXykUuj1_ZI,27679
 sxs/utilities/__init__.py,sha256=Np27-TQRWfGP8HtDWlZcnZ_UL8QHBXLjXHGHGAbHD2g,4580
@@ -74,7 +75,7 @@ sxs/zenodo/api/__init__.py,sha256=EM_eh4Q8R5E0vIfMhyIR1IYFfOBu6vA0UTasgX9gHys,21
 sxs/zenodo/api/deposit.py,sha256=uor1irig-gBvrEQNg_Wb0ZuiXhZC9AeLwuJu3vB30e0,36946
 sxs/zenodo/api/login.py,sha256=Yz0ytgi81_5BpDzhrS0WPMXlvU2qUaCK8yn8zxfEbko,18007
 sxs/zenodo/api/records.py,sha256=nKkhoHZ95CTztHF9Zzaug5p7IiUCJG4Em1i-l-WqH6U,3689
-sxs-2023.1.3.dist-info/METADATA,sha256=RGUj5SoR_0KXUuJ-DaRCItRP5RkF6fy6Lf77Ax3x7hk,9362
-sxs-2023.1.3.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-sxs-2023.1.3.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
-sxs-2023.1.3.dist-info/RECORD,,
+sxs-2023.1.4.dist-info/METADATA,sha256=R_Zl8moau8vaaPTyUcOV24P03QBPTnod2wH4ZtRqg04,9362
+sxs-2023.1.4.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
+sxs-2023.1.4.dist-info/licenses/LICENSE,sha256=ptVOd5m7LDM5ZF0x32cxb8c2Nd5NDmAhy6DX7xt_7VA,1080
+sxs-2023.1.4.dist-info/RECORD,,