Skip to content

Commit

Permalink
Merge pull request #44 from BlackHolePerturbationToolkit/dev
Browse files Browse the repository at this point in the history
fixed SchEcc waveform base for additional args
  • Loading branch information
mikekatz04 authored Nov 10, 2021
2 parents 0ff5e11 + fa950a1 commit 9fd853a
Show file tree
Hide file tree
Showing 17 changed files with 22 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.2
Current Version: 1.4.3

## Authors

Expand Down
Binary file modified docs/doctrees/README.doctree
Binary file not shown.
Binary file modified docs/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/doctrees/general/docs_main.doctree
Binary file not shown.
Binary file modified docs/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/doctrees/user/main.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/html/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.2</p>
<p>Current Version: 1.4.3</p>
</div>
<div class="section" id="authors">
<h2>Authors<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_sources/README.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.2
Current Version: 1.4.3

Authors
-------
Expand Down
1 change: 1 addition & 0 deletions docs/html/_sources/general/docs_main.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Package TODOs
Change Log
===========

- 1.4.3: Bug fixes for additional arguments in SchEcc waveform base.
- 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.
Expand Down
1 change: 1 addition & 0 deletions docs/html/general/docs_main.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.3: Bug fixes for additional arguments in SchEcc waveform base.</p></li>
<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>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.2</p>
<p>Current Version: 1.4.3</p>
</div>
<div class="section" id="authors">
<h2>Authors<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js

Large diffs are not rendered by default.

9 changes: 6 additions & 3 deletions docs/html/user/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ <h3>Fast Schwarzschild Eccentric Flux-based Waveform<a class="headerlink" href="

<dl class="py method">
<dt id="few.waveform.FastSchwarzschildEccentricFlux.__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">p0</span></em>, <em class="sig-param"><span class="n">e0</span></em>, <em class="sig-param"><span class="n">theta</span></em>, <em class="sig-param"><span class="n">phi</span></em>, <em class="sig-param"><span class="n">dist</span><span class="o">=</span><span class="default_value">None</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_r0</span><span class="o">=</span><span class="default_value">0.0</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>, <em class="sig-param"><span class="n">eps</span><span class="o">=</span><span class="default_value">1e-05</span></em>, <em class="sig-param"><span class="n">show_progress</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">batch_size</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">mode_selection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_minus_m</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="headerlink" href="#few.waveform.FastSchwarzschildEccentricFlux.__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">p0</span></em>, <em class="sig-param"><span class="n">e0</span></em>, <em class="sig-param"><span class="n">theta</span></em>, <em class="sig-param"><span class="n">phi</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="n">dist</span><span class="o">=</span><span class="default_value">None</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_r0</span><span class="o">=</span><span class="default_value">0.0</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>, <em class="sig-param"><span class="n">eps</span><span class="o">=</span><span class="default_value">1e-05</span></em>, <em class="sig-param"><span class="n">show_progress</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">batch_size</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">mode_selection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_minus_m</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="headerlink" href="#few.waveform.FastSchwarzschildEccentricFlux.__call__" title="Permalink to this definition"></a></dt>
<dd><p>Call function for SchwarzschildEccentric models.</p>
<p>This function will take input parameters and produce Schwarzschild
eccentric waveforms. It will use all of the modules preloaded to
Expand All @@ -405,6 +405,7 @@ <h3>Fast Schwarzschild Eccentric Flux-based Waveform<a class="headerlink" href="
<li><p><strong>e0</strong> (<em>double</em>) – Initial eccentricity (<span class="math notranslate nohighlight">\(0.0\leq e_0\leq0.7\)</span>).</p></li>
<li><p><strong>theta</strong> (<em>double</em>) – Polar viewing angle (<span class="math notranslate nohighlight">\(-\pi/2\leq\Theta\leq\pi/2\)</span>).</p></li>
<li><p><strong>phi</strong> (<em>double</em>) – Azimuthal viewing angle.</p></li>
<li><p><strong>*args</strong> (<em>list</em>) – extra args for trajectory model.</p></li>
<li><p><strong>dist</strong> (<em>double</em><em>, </em><em>optional</em>) – Luminosity distance in Gpc. Default is None. If None,
will return source frame.</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>.
Expand Down Expand Up @@ -990,7 +991,7 @@ <h3>Slow Schwarzschild Eccentric Flux-based Waveform<a class="headerlink" href="

<dl class="py method">
<dt id="few.waveform.SlowSchwarzschildEccentricFlux.__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">p0</span></em>, <em class="sig-param"><span class="n">e0</span></em>, <em class="sig-param"><span class="n">theta</span></em>, <em class="sig-param"><span class="n">phi</span></em>, <em class="sig-param"><span class="n">dist</span><span class="o">=</span><span class="default_value">None</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_r0</span><span class="o">=</span><span class="default_value">0.0</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>, <em class="sig-param"><span class="n">eps</span><span class="o">=</span><span class="default_value">1e-05</span></em>, <em class="sig-param"><span class="n">show_progress</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">batch_size</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">mode_selection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_minus_m</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="headerlink" href="#few.waveform.SlowSchwarzschildEccentricFlux.__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">p0</span></em>, <em class="sig-param"><span class="n">e0</span></em>, <em class="sig-param"><span class="n">theta</span></em>, <em class="sig-param"><span class="n">phi</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="n">dist</span><span class="o">=</span><span class="default_value">None</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_r0</span><span class="o">=</span><span class="default_value">0.0</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>, <em class="sig-param"><span class="n">eps</span><span class="o">=</span><span class="default_value">1e-05</span></em>, <em class="sig-param"><span class="n">show_progress</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">batch_size</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">mode_selection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_minus_m</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="headerlink" href="#few.waveform.SlowSchwarzschildEccentricFlux.__call__" title="Permalink to this definition"></a></dt>
<dd><p>Call function for SchwarzschildEccentric models.</p>
<p>This function will take input parameters and produce Schwarzschild
eccentric waveforms. It will use all of the modules preloaded to
Expand All @@ -1005,6 +1006,7 @@ <h3>Slow Schwarzschild Eccentric Flux-based Waveform<a class="headerlink" href="
<li><p><strong>e0</strong> (<em>double</em>) – Initial eccentricity (<span class="math notranslate nohighlight">\(0.0\leq e_0\leq0.7\)</span>).</p></li>
<li><p><strong>theta</strong> (<em>double</em>) – Polar viewing angle (<span class="math notranslate nohighlight">\(-\pi/2\leq\Theta\leq\pi/2\)</span>).</p></li>
<li><p><strong>phi</strong> (<em>double</em>) – Azimuthal viewing angle.</p></li>
<li><p><strong>*args</strong> (<em>list</em>) – extra args for trajectory model.</p></li>
<li><p><strong>dist</strong> (<em>double</em><em>, </em><em>optional</em>) – Luminosity distance in Gpc. Default is None. If None,
will return source frame.</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>.
Expand Down Expand Up @@ -2521,7 +2523,7 @@ <h3>Schwarzschild Eccentric<a class="headerlink" href="#schwarzschild-eccentric"

<dl class="py method">
<dt id="few.waveform.SchwarzschildEccentricWaveformBase.__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">p0</span></em>, <em class="sig-param"><span class="n">e0</span></em>, <em class="sig-param"><span class="n">theta</span></em>, <em class="sig-param"><span class="n">phi</span></em>, <em class="sig-param"><span class="n">dist</span><span class="o">=</span><span class="default_value">None</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_r0</span><span class="o">=</span><span class="default_value">0.0</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>, <em class="sig-param"><span class="n">eps</span><span class="o">=</span><span class="default_value">1e-05</span></em>, <em class="sig-param"><span class="n">show_progress</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">batch_size</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">mode_selection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_minus_m</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="headerlink" href="#few.waveform.SchwarzschildEccentricWaveformBase.__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">p0</span></em>, <em class="sig-param"><span class="n">e0</span></em>, <em class="sig-param"><span class="n">theta</span></em>, <em class="sig-param"><span class="n">phi</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="n">dist</span><span class="o">=</span><span class="default_value">None</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_r0</span><span class="o">=</span><span class="default_value">0.0</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>, <em class="sig-param"><span class="n">eps</span><span class="o">=</span><span class="default_value">1e-05</span></em>, <em class="sig-param"><span class="n">show_progress</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">batch_size</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">mode_selection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_minus_m</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="headerlink" href="#few.waveform.SchwarzschildEccentricWaveformBase.__call__" title="Permalink to this definition"></a></dt>
<dd><p>Call function for SchwarzschildEccentric models.</p>
<p>This function will take input parameters and produce Schwarzschild
eccentric waveforms. It will use all of the modules preloaded to
Expand All @@ -2536,6 +2538,7 @@ <h3>Schwarzschild Eccentric<a class="headerlink" href="#schwarzschild-eccentric"
<li><p><strong>e0</strong> (<em>double</em>) – Initial eccentricity (<span class="math notranslate nohighlight">\(0.0\leq e_0\leq0.7\)</span>).</p></li>
<li><p><strong>theta</strong> (<em>double</em>) – Polar viewing angle (<span class="math notranslate nohighlight">\(-\pi/2\leq\Theta\leq\pi/2\)</span>).</p></li>
<li><p><strong>phi</strong> (<em>double</em>) – Azimuthal viewing angle.</p></li>
<li><p><strong>*args</strong> (<em>list</em>) – extra args for trajectory model.</p></li>
<li><p><strong>dist</strong> (<em>double</em><em>, </em><em>optional</em>) – Luminosity distance in Gpc. Default is None. If None,
will return source frame.</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>.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.2
Current Version: 1.4.3

Authors
-------
Expand Down
1 change: 1 addition & 0 deletions docs/source/general/docs_main.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Package TODOs
Change Log
===========

- 1.4.3: Bug fixes for additional arguments in SchEcc waveform base.
- 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.
Expand Down
6 changes: 4 additions & 2 deletions few/utils/utility.py
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,7 @@ def get_p_at_t(
) # should be fairly close.
else:
p_sep = 6 + 2 * traj_args[index_of_e]
bounds = [p_sep + 0.101, 16.0 + 2 * traj_args[index_of_e]]
bounds = [p_sep + 0.1, 16.0 + 2 * traj_args[index_of_e]]

elif bounds[0] is None:
if not enforce_schwarz_sep:
Expand All @@ -643,7 +643,7 @@ def get_p_at_t(
) # should be fairly close.
else:
p_sep = 6 + 2 * traj_args[index_of_e]
bounds[0] = p_sep + 0.101
bounds[0] = p_sep + 0.1

elif bounds[1] is None:
bounds[1] = 16.0 + 2 * traj_args[index_of_e]
Expand Down Expand Up @@ -722,6 +722,8 @@ def get_mu_at_t(
"1.4.0": 3981654,
"1.4.1": 3981654,
"1.4.2": 3981654,
"1.4.3": 3981654,

}


Expand Down
3 changes: 3 additions & 0 deletions few/waveform.py
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,7 @@ def __call__(
e0,
theta,
phi,
*args,
dist=None,
Phi_phi0=0.0,
Phi_r0=0.0,
Expand All @@ -508,6 +509,7 @@ def __call__(
e0 (double): Initial eccentricity (:math:`0.0\leq e_0\leq0.7`).
theta (double): Polar viewing angle (:math:`-\pi/2\leq\Theta\leq\pi/2`).
phi (double): Azimuthal viewing angle.
*args (list): extra args for trajectory model.
dist (double, optional): Luminosity distance in Gpc. Default is None. If None,
will return source frame.
Phi_phi0 (double, optional): Initial phase for :math:`\Phi_\phi`.
Expand Down Expand Up @@ -560,6 +562,7 @@ def __call__(
p0,
e0,
1.0,
*args,
Phi_phi0=Phi_phi0,
Phi_theta0=0.0,
Phi_r0=Phi_r0,
Expand Down

0 comments on commit 9fd853a

Please sign in to comment.