Merge pull request #43 from BlackHolePerturbationToolkit/dev

bug fixes

README.md

@@ -136,7 +136,7 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
 
 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/BlackHolePerturbationToolkit/FastEMRIWaveforms/tags).
 
-Current Version: 1.4.1
+Current Version: 1.4.2
 
 ## Authors
 

docs/html/README.html

@@ -382,7 +382,7 @@ <h2>Versioning<a class="headerlink" href="#versioning" title="Permalink to this
 <p>We use <a class="reference external" href="http://semver.org/">SemVer</a> for versioning. For the versions
 available, see the <a class="reference external" href="https://github.com/BlackHolePerturbationToolkit/FastEMRIWaveforms/tags">tags on this
 repository</a>.</p>
-<p>Current Version: 1.4.1</p>
+<p>Current Version: 1.4.2</p>
 </div>
 <div class="section" id="authors">
 <h2>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>

docs/html/_sources/README.rst.txt

@@ -199,7 +199,7 @@ We use `SemVer <http://semver.org/>`__ for versioning. For the versions
 available, see the `tags on this
 repository <https://github.com/BlackHolePerturbationToolkit/FastEMRIWaveforms/tags>`__.
 
-Current Version: 1.4.1
+Current Version: 1.4.2
 
 Authors
 -------

docs/html/_sources/general/docs_main.rst.txt

@@ -34,6 +34,7 @@ Package TODOs
 Change Log
 ===========
 
+- 1.4.2: Bug fixes for additional arguments in AAK waveform.
 - 1.4.1: Bug fixes.
 - 1.4.0: Ability to access OMP threads. Set CUDA device. Change fundamental frequency files to "utility". Initial error handler. Trajectory overhaul. get_at_t function updates.
 - 1.3.7: Fixed get_at_t functions. Added new GPU architecture. Removed oldest architecture. Fixed issue #30 & #32.

docs/html/general/docs_main.html

@@ -238,6 +238,7 @@ <h1>Package TODOs<a class="headerlink" href="#package-todos" title="Permalink to
 <div class="section" id="change-log">
 <h1>Change Log<a class="headerlink" href="#change-log" title="Permalink to this headline">¶</a></h1>
 <ul class="simple">
+<li><p>1.4.2: Bug fixes for additional arguments in AAK waveform.</p></li>
 <li><p>1.4.1: Bug fixes.</p></li>
 <li><p>1.4.0: Ability to access OMP threads. Set CUDA device. Change fundamental frequency files to “utility”. Initial error handler. Trajectory overhaul. get_at_t function updates.</p></li>
 <li><p>1.3.7: Fixed get_at_t functions. Added new GPU architecture. Removed oldest architecture. Fixed issue #30 &amp; #32.</p></li>

docs/html/index.html

@@ -390,7 +390,7 @@ <h2>Versioning<a class="headerlink" href="#versioning" title="Permalink to this
 <p>We use <a class="reference external" href="http://semver.org/">SemVer</a> for versioning. For the versions
 available, see the <a class="reference external" href="https://github.com/BlackHolePerturbationToolkit/FastEMRIWaveforms/tags">tags on this
 repository</a>.</p>
-<p>Current Version: 1.4.1</p>
+<p>Current Version: 1.4.2</p>
 </div>
 <div class="section" id="authors">
 <h2>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>

docs/html/user/main.html

@@ -1572,7 +1572,7 @@ <h3>Generic Kerr AAK with 5PN Trajectory<a class="headerlink" href="#generic-ker
 </dl>
 <dl class="py method">
 <dt id="few.waveform.Pn5AAKWaveform.__call__">
-<code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">M</span></em>, <em class="sig-param"><span class="n">mu</span></em>, <em class="sig-param"><span class="n">a</span></em>, <em class="sig-param"><span class="n">p0</span></em>, <em class="sig-param"><span class="n">e0</span></em>, <em class="sig-param"><span class="n">Y0</span></em>, <em class="sig-param"><span class="n">dist</span></em>, <em class="sig-param"><span class="n">qS</span></em>, <em class="sig-param"><span class="n">phiS</span></em>, <em class="sig-param"><span class="n">qK</span></em>, <em class="sig-param"><span class="n">phiK</span></em>, <em class="sig-param"><span class="n">Phi_phi0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">Phi_theta0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">Phi_r0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">mich</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">dt</span><span class="o">=</span><span class="default_value">10.0</span></em>, <em class="sig-param"><span class="n">T</span><span class="o">=</span><span class="default_value">1.0</span></em><span class="sig-paren">)</span><a class="headerlink" href="#few.waveform.Pn5AAKWaveform.__call__" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">M</span></em>, <em class="sig-param"><span class="n">mu</span></em>, <em class="sig-param"><span class="n">a</span></em>, <em class="sig-param"><span class="n">p0</span></em>, <em class="sig-param"><span class="n">e0</span></em>, <em class="sig-param"><span class="n">Y0</span></em>, <em class="sig-param"><span class="n">dist</span></em>, <em class="sig-param"><span class="n">qS</span></em>, <em class="sig-param"><span class="n">phiS</span></em>, <em class="sig-param"><span class="n">qK</span></em>, <em class="sig-param"><span class="n">phiK</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="n">Phi_phi0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">Phi_theta0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">Phi_r0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">mich</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">dt</span><span class="o">=</span><span class="default_value">10.0</span></em>, <em class="sig-param"><span class="n">T</span><span class="o">=</span><span class="default_value">1.0</span></em><span class="sig-paren">)</span><a class="headerlink" href="#few.waveform.Pn5AAKWaveform.__call__" title="Permalink to this definition">¶</a></dt>
 <dd><p>Call function for AAK + 5PN model.</p>
 <p>This function will take input parameters and produce AAK waveforms with 5PN trajectories in generic Kerr.</p>
 <dl class="field-list simple">
@@ -1596,6 +1596,8 @@ <h3>Generic Kerr AAK with 5PN Trajectory<a class="headerlink" href="#generic-ker
 coordinates.</p></li>
 <li><p><strong>phiK</strong> (<em>double</em>) – Initial BH spin azimuthal angle in
 ecliptic coordinates.</p></li>
+<li><p><strong>*args</strong> (<em>tuple</em><em>, </em><em>optional</em>) – Any additional arguments required for the
+trajectory.</p></li>
 <li><p><strong>Phi_phi0</strong> (<em>double</em><em>, </em><em>optional</em>) – Initial phase for <span class="math notranslate nohighlight">\(\Phi_\phi\)</span>.
 Default is 0.0.</p></li>
 <li><p><strong>Phi_theta0</strong> (<em>double</em><em>, </em><em>optional</em>) – Initial phase for <span class="math notranslate nohighlight">\(\Phi_\Theta\)</span>.
@@ -3209,7 +3211,7 @@ <h3>5PN + AAK Waveform for Generic Kerr<a class="headerlink" href="#pn-aak-wavef
 
 <dl class="py method">
 <dt id="few.waveform.AAKWaveformBase.__call__">
-<code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">M</span></em>, <em class="sig-param"><span class="n">mu</span></em>, <em class="sig-param"><span class="n">a</span></em>, <em class="sig-param"><span class="n">p0</span></em>, <em class="sig-param"><span class="n">e0</span></em>, <em class="sig-param"><span class="n">Y0</span></em>, <em class="sig-param"><span class="n">dist</span></em>, <em class="sig-param"><span class="n">qS</span></em>, <em class="sig-param"><span class="n">phiS</span></em>, <em class="sig-param"><span class="n">qK</span></em>, <em class="sig-param"><span class="n">phiK</span></em>, <em class="sig-param"><span class="n">Phi_phi0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">Phi_theta0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">Phi_r0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">mich</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">dt</span><span class="o">=</span><span class="default_value">10.0</span></em>, <em class="sig-param"><span class="n">T</span><span class="o">=</span><span class="default_value">1.0</span></em><span class="sig-paren">)</span><a class="headerlink" href="#few.waveform.AAKWaveformBase.__call__" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">M</span></em>, <em class="sig-param"><span class="n">mu</span></em>, <em class="sig-param"><span class="n">a</span></em>, <em class="sig-param"><span class="n">p0</span></em>, <em class="sig-param"><span class="n">e0</span></em>, <em class="sig-param"><span class="n">Y0</span></em>, <em class="sig-param"><span class="n">dist</span></em>, <em class="sig-param"><span class="n">qS</span></em>, <em class="sig-param"><span class="n">phiS</span></em>, <em class="sig-param"><span class="n">qK</span></em>, <em class="sig-param"><span class="n">phiK</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="n">Phi_phi0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">Phi_theta0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">Phi_r0</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">mich</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">dt</span><span class="o">=</span><span class="default_value">10.0</span></em>, <em class="sig-param"><span class="n">T</span><span class="o">=</span><span class="default_value">1.0</span></em><span class="sig-paren">)</span><a class="headerlink" href="#few.waveform.AAKWaveformBase.__call__" title="Permalink to this definition">¶</a></dt>
 <dd><p>Call function for AAK + 5PN model.</p>
 <p>This function will take input parameters and produce AAK waveforms with 5PN trajectories in generic Kerr.</p>
 <dl class="field-list simple">
@@ -3233,6 +3235,8 @@ <h3>5PN + AAK Waveform for Generic Kerr<a class="headerlink" href="#pn-aak-wavef
 coordinates.</p></li>
 <li><p><strong>phiK</strong> (<em>double</em>) – Initial BH spin azimuthal angle in
 ecliptic coordinates.</p></li>
+<li><p><strong>*args</strong> (<em>tuple</em><em>, </em><em>optional</em>) – Any additional arguments required for the
+trajectory.</p></li>
 <li><p><strong>Phi_phi0</strong> (<em>double</em><em>, </em><em>optional</em>) – Initial phase for <span class="math notranslate nohighlight">\(\Phi_\phi\)</span>.
 Default is 0.0.</p></li>
 <li><p><strong>Phi_theta0</strong> (<em>double</em><em>, </em><em>optional</em>) – Initial phase for <span class="math notranslate nohighlight">\(\Phi_\Theta\)</span>.

docs/source/README.rst

@@ -199,7 +199,7 @@ We use `SemVer <http://semver.org/>`__ for versioning. For the versions
 available, see the `tags on this
 repository <https://github.com/BlackHolePerturbationToolkit/FastEMRIWaveforms/tags>`__.
 
-Current Version: 1.4.1
+Current Version: 1.4.2
 
 Authors
 -------

docs/source/general/docs_main.rst

@@ -34,6 +34,7 @@ Package TODOs
 Change Log
 ===========
 
+- 1.4.2: Bug fixes for additional arguments in AAK waveform.
 - 1.4.1: Bug fixes.
 - 1.4.0: Ability to access OMP threads. Set CUDA device. Change fundamental frequency files to "utility". Initial error handler. Trajectory overhaul. get_at_t function updates.
 - 1.3.7: Fixed get_at_t functions. Added new GPU architecture. Removed oldest architecture. Fixed issue #30 & #32.

few/utils/utility.py

@@ -721,6 +721,7 @@ def get_mu_at_t(
     "1.3.7": 3981654,
     "1.4.0": 3981654,
     "1.4.1": 3981654,
+    "1.4.2": 3981654,
 }
 
 

few/waveform.py

@@ -214,7 +214,7 @@ def __call__(
         Phi_theta0,
         Phi_r0,
         *add_args,
-        **kwargs
+        **kwargs,
     ):
         """Generate the waveform with the given parameters.
 
@@ -565,7 +565,7 @@ def __call__(
             Phi_r0=Phi_r0,
             T=T,
             dt=dt,
-            **self.inspiral_kwargs
+            **self.inspiral_kwargs,
         )
 
         # makes sure p and e are generally within the model
@@ -809,7 +809,7 @@ def __init__(
         Ylm_kwargs={},
         use_gpu=False,
         *args,
-        **kwargs
+        **kwargs,
     ):
 
         inspiral_kwargs["func"] = "SchwarzEccFlux"
@@ -825,7 +825,7 @@ def __init__(
             Ylm_kwargs=Ylm_kwargs,
             use_gpu=use_gpu,
             *args,
-            **kwargs
+            **kwargs,
         )
 
     def attributes_FastSchwarzschildEccentricFlux(self):
@@ -916,7 +916,7 @@ def __init__(
         Ylm_kwargs={},
         use_gpu=False,
         *args,
-        **kwargs
+        **kwargs,
     ):
 
         # declare specific properties
@@ -934,7 +934,7 @@ def __init__(
             Ylm_kwargs=Ylm_kwargs,
             use_gpu=use_gpu,
             *args,
-            **kwargs
+            **kwargs,
         )
 
 
@@ -1073,6 +1073,7 @@ def __call__(
         phiS,
         qK,
         phiK,
+        *args,
         Phi_phi0=0.0,
         Phi_theta0=0.0,
         Phi_r0=0.0,
@@ -1103,6 +1104,8 @@ def __call__(
                 coordinates.
             phiK (double): Initial BH spin azimuthal angle in
                 ecliptic coordinates.
+            *args (tuple, optional): Any additional arguments required for the
+                trajectory.
             Phi_phi0 (double, optional): Initial phase for :math:`\Phi_\phi`.
                 Default is 0.0.
             Phi_theta0 (double, optional): Initial phase for :math:`\Phi_\Theta`.
@@ -1139,12 +1142,13 @@ def __call__(
             p0,
             e0,
             Y0,
+            *args,
             Phi_phi0=Phi_phi0,
             Phi_theta0=Phi_theta0,
             Phi_r0=Phi_r0,
             T=T,
             dt=dt,
-            **self.inspiral_kwargs
+            **self.inspiral_kwargs,
         )
 
         # makes sure p, Y, and e are generally within the model

src/ode_base.cc

@@ -48,8 +48,6 @@ void pn5(double* pdot, double* edot, double* Ydot,
     ne = 10;
     *Ydot = epsilon * dYdt8H_5PNe10 (a, p, e, Y, Nv, ne);
 
-    // convert to proper inclination input to fundamental frequencies
-    double xI = Y_to_xI(a, p, e, Y);
 }