Skip to content

Commit

Permalink
links fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
@mikekatz04
mikekatz04 committed Jul 31, 2020
1 parent 232dfd0 commit 0e0d1e7
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 46 deletions.
Binary file modified docs/doctrees/environment.pickle
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/html/searchindex.js
View file

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions docs/html/tutorial/SchwarzschildEccentricWaveform_intro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -492,18 +492,18 @@ <h1>Fast and Accurate EMRI Waveforms Tutorial<a class="headerlink" href="#Fast-a
</div>
<div class="section" id="Full-EMRI-Waveforms">
<h1>Full EMRI Waveforms<a class="headerlink" href="#Full-EMRI-Waveforms" title="Permalink to this headline"></a></h1>
<p>In the section, we will describe how to create EMRI waveforms with both our fast and slow EMRI waveform model. The current full models include <code class="docutils literal notranslate"><span class="pre">`FastSchwarzschildEccentricFlux</span></code> &lt;<a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.waveform.FastSchwarzschildEccentricFlux">https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.waveform.FastSchwarzschildEccentricFlux</a>&gt;`__ and <code class="docutils literal notranslate"><span class="pre">`SlowSchwarzschildEccentricFlux</span></code> &lt;<a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.waveform.SlowSchwarzschildEccentricFlux">https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.waveform.SlowSchwarzschildEccentricFlux</a>&gt;`__. These are fast and slow versions of models that evolve
eccentric flux-based trajectories in a Schwarzschild background. The fast model can be run exactly as shown here on CPUs or GPUs by providing the correct initialization arguments.</p>
<p>In the section, we will describe how to create EMRI waveforms with both our fast and slow EMRI waveform model. The current full models include <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.waveform.FastSchwarzschildEccentricFlux">FastSchwarzschildEccentricFlux</a> and <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.waveform.SlowSchwarzschildEccentricFlux">SlowSchwarzschildEccentricFlux</a>. These are fast and slow versions of models that evolve eccentric
flux-based trajectories in a Schwarzschild background. The fast model can be run exactly as shown here on CPUs or GPUs by providing the correct initialization arguments.</p>
<p>The waveform model produces $h(t) = h_p - ih_c(t) $. It takes as arguments <span class="math notranslate nohighlight">\(\{M, \mu, p_0, e_0, \Phi_{\phi,0}, \Phi_{r, 0}\}\)</span>. <span class="math notranslate nohighlight">\(M\)</span> is the larger mass (<span class="math notranslate nohighlight">\(M_\odot\)</span>), <span class="math notranslate nohighlight">\(\mu\)</span> is the compact object mass (<span class="math notranslate nohighlight">\(M_\odot\)</span>), <span class="math notranslate nohighlight">\(p_0\)</span> is the initial semi-latus rectum (dimensionless), <span class="math notranslate nohighlight">\(e_0\)</span> is the initial eccentricity, and the final two are the initial phases in <span class="math notranslate nohighlight">\(\phi, r\)</span>.</p>
<div class="section" id="FastSchwarzschildEccentricFlux">
<h2><a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.waveform.FastSchwarzschildEccentricFlux">FastSchwarzschildEccentricFlux</a><a class="headerlink" href="#FastSchwarzschildEccentricFlux" title="Permalink to this headline"></a></h2>
<p>The fast waveform generates sparse trajectories with ~100 points. Amplitudes for all modes are then determined with ROMAN network. From these amplitudes, we perform mode selection to remove modes that do not contribute significantly to the waveform. The remaining modes and phases are then interpolated with cubic splines. In one final step, the amplitude, phase, and angular harmonic information is then combined with an interpolated summation.</p>
<ul class="simple">
<li><p>Trajectory Module: <code class="docutils literal notranslate"><span class="pre">`RunSchwarzEccFluxInspiral</span></code> &lt;<a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.trajectory.flux.RunSchwarzEccFluxInspiral">https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.trajectory.flux.RunSchwarzEccFluxInspiral</a>&gt;`__</p></li>
<li><p>Amplitude Module: <code class="docutils literal notranslate"><span class="pre">`RomanAmplitude</span></code> &lt;<a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.amplitude.romannet.RomanAmplitude">https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.amplitude.romannet.RomanAmplitude</a>&gt;`__</p></li>
<li><p>Summation Module: <code class="docutils literal notranslate"><span class="pre">`InterpolateModeSum</span></code> &lt;<a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.summation.interpolatedmodesum.InterpolatedModeSum">https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.summation.interpolatedmodesum.InterpolatedModeSum</a>&gt;`__</p></li>
<li><p>Mode Selection: <code class="docutils literal notranslate"><span class="pre">`ModeSelector</span></code> &lt;<a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.modeselector.ModeSelector">https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.modeselector.ModeSelector</a>&gt;`__</p></li>
<li><p>Angular Harmonics: <code class="docutils literal notranslate"><span class="pre">`GetYlms</span></code> &lt;<a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.ylm.GetYlms">https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.ylm.GetYlms</a>&gt;`__</p></li>
<li><p>Trajectory Module: <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.trajectory.flux.RunSchwarzEccFluxInspiral">RunSchwarzEccFluxInspiral</a></p></li>
<li><p>Amplitude Module: <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.amplitude.romannet.RomanAmplitude">RomanAmplitude</a></p></li>
<li><p>Summation Module: <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.summation.interpolatedmodesum.InterpolatedModeSum">InterpolateModeSum</a></p></li>
<li><p>Mode Selection: <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.modeselector.ModeSelector">ModeSelector</a></p></li>
<li><p>Angular Harmonics: <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.ylm.GetYlms">GetYlms</a></p></li>
</ul>
<div class="nbinput nblast docutils container">
<div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[2]:
Expand Down Expand Up @@ -729,11 +729,11 @@ <h2><a class="reference external" href="https://mikekatz04.github.io/FastEMRIWav
<p>The slow waveform generates dense trajectories with at every <code class="docutils literal notranslate"><span class="pre">dt</span></code> seconds within <code class="docutils literal notranslate"><span class="pre">T</span></code> years. Amplitudes for all modes are then determined with a 2d bicubic spline over semi-latus rectum and eccentricity for each mode. This is done at each dense time step. We do not perform mode selection because this is the slow and most accurate model against which we compare the fast model. The final summation is a direct combination of phase, amplitude, and Ylm information at each dense timestep.</p>
<p><strong>Note</strong>: One thing to pay attention to with the slow waveform is batch size. This is determined by memory limits. Usually anything under ~10000 is fine.</p>
<ul class="simple">
<li><p>Trajectory Module: <code class="docutils literal notranslate"><span class="pre">`RunSchwarzEccFluxInspiral</span></code> &lt;<a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.trajectory.flux.RunSchwarzEccFluxInspiral">https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.trajectory.flux.RunSchwarzEccFluxInspiral</a>&gt;`__</p></li>
<li><p>Amplitude Module: <code class="docutils literal notranslate"><span class="pre">`Interp2DAmplitude</span></code> &lt;<a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.amplitude.interp2dcubicspline.Interp2DAmplitude">https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.amplitude.interp2dcubicspline.Interp2DAmplitude</a>&gt;`__</p></li>
<li><p>Summation Module: <code class="docutils literal notranslate"><span class="pre">`DirectModeSum</span></code> &lt;<a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.summation.directmodesum.DirectModeSum">https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.summation.directmodesum.DirectModeSum</a>&gt;`__</p></li>
<li><p>Trajectory Module: <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.trajectory.flux.RunSchwarzEccFluxInspiral">RunSchwarzEccFluxInspiral</a></p></li>
<li><p>Amplitude Module: <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.amplitude.interp2dcubicspline.Interp2DAmplitude">Interp2DAmplitude</a></p></li>
<li><p>Summation Module: <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.summation.directmodesum.DirectModeSum">DirectModeSum</a></p></li>
<li><p>Mode Selection: None</p></li>
<li><p>Angular Harmonics: <code class="docutils literal notranslate"><span class="pre">`GetYlms</span></code> &lt;<a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.ylm.GetYlms">https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.ylm.GetYlms</a>&gt;`__</p></li>
<li><p>Angular Harmonics: <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.ylm.GetYlms">GetYlms</a></p></li>
</ul>
<div class="nbinput docutils container">
<div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[8]:
Expand Down Expand Up @@ -1693,7 +1693,7 @@ <h2>Direct summation<a class="headerlink" href="#Direct-summation" title="Permal
</div>
<div class="section" id="Creating-modules">
<h1>Creating modules<a class="headerlink" href="#Creating-modules" title="Permalink to this headline"></a></h1>
<p>In addition to using our built-in modules and waveforms, you can easily create your own module or waveform. Below is an example of creating your own trajectory module and using it in a custom waveform. If you can get a reasonably fast trajectory from your specific brand of EMRI physics, you can be generating waveforms in no time! Please see the <a href="#id3"><span class="problematic" id="id4">`documentation &lt;&gt;`__</span></a> on this for more details on the constructions behind this.</p>
<p>In addition to using our built-in modules and waveforms, you can easily create your own module or waveform. Below is an example of creating your own trajectory module and using it in a custom waveform. If you can get a reasonably fast trajectory from your specific brand of EMRI physics, you can be generating waveforms in no time! Please see the <a class="reference external" href="https://mikekatz04.github.io/FastEMRIWaveforms/">documentation</a> on this for more details on the constructions behind this.</p>
<p><strong>Important Note</strong>: If you do use this package to examine EMRI analysis problems, please contact the authors of this code (see docs) about possible collaboration and/or contribution.</p>
<div class="section" id="Post-Newtonian-trajectory">
<h2>Post-Newtonian trajectory<a class="headerlink" href="#Post-Newtonian-trajectory" title="Permalink to this headline"></a></h2>
Expand Down
22 changes: 11 additions & 11 deletions docs/html/tutorial/SchwarzschildEccentricWaveform_intro.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"In the section, we will describe how to create EMRI waveforms with both our fast and slow EMRI waveform model. The current full models include [`FastSchwarzschildEccentricFlux`](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.waveform.FastSchwarzschildEccentricFlux) and [`SlowSchwarzschildEccentricFlux`](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.waveform.SlowSchwarzschildEccentricFlux). These are fast and slow versions of models that evolve eccentric flux-based trajectories in a Schwarzschild background. The fast model can be run exactly as shown here on CPUs or GPUs by providing the correct initialization arguments. \n",
"In the section, we will describe how to create EMRI waveforms with both our fast and slow EMRI waveform model. The current full models include [FastSchwarzschildEccentricFlux](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.waveform.FastSchwarzschildEccentricFlux) and [SlowSchwarzschildEccentricFlux](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.waveform.SlowSchwarzschildEccentricFlux). These are fast and slow versions of models that evolve eccentric flux-based trajectories in a Schwarzschild background. The fast model can be run exactly as shown here on CPUs or GPUs by providing the correct initialization arguments. \n",
"\n",
"The waveform model produces $h(t) = h_p - ih_c(t) $. It takes as arguments $\\{M, \\mu, p_0, e_0, \\Phi_{\\phi,0}, \\Phi_{r, 0}\\}$. $M$ is the larger mass ($M_\\odot$), $\\mu$ is the compact object mass ($M_\\odot$), $p_0$ is the initial semi-latus rectum (dimensionless), $e_0$ is the initial eccentricity, and the final two are the initial phases in $\\phi, r$."
]
Expand All @@ -81,15 +81,15 @@
"source": [
"The fast waveform generates sparse trajectories with ~100 points. Amplitudes for all modes are then determined with ROMAN network. From these amplitudes, we perform mode selection to remove modes that do not contribute significantly to the waveform. The remaining modes and phases are then interpolated with cubic splines. In one final step, the amplitude, phase, and angular harmonic information is then combined with an interpolated summation. \n",
"\n",
"* Trajectory Module: [`RunSchwarzEccFluxInspiral`](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.trajectory.flux.RunSchwarzEccFluxInspiral)\n",
"* Trajectory Module: [RunSchwarzEccFluxInspiral](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.trajectory.flux.RunSchwarzEccFluxInspiral)\n",
"\n",
"* Amplitude Module: [`RomanAmplitude`](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.amplitude.romannet.RomanAmplitude)\n",
"* Amplitude Module: [RomanAmplitude](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.amplitude.romannet.RomanAmplitude)\n",
"\n",
"* Summation Module: [`InterpolateModeSum`](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.summation.interpolatedmodesum.InterpolatedModeSum)\n",
"* Summation Module: [InterpolateModeSum](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.summation.interpolatedmodesum.InterpolatedModeSum)\n",
"\n",
"* Mode Selection: [`ModeSelector`](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.modeselector.ModeSelector)\n",
"* Mode Selection: [ModeSelector](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.modeselector.ModeSelector)\n",
"\n",
"* Angular Harmonics: [`GetYlms`](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.ylm.GetYlms)\n"
"* Angular Harmonics: [GetYlms](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.ylm.GetYlms)\n"
]
},
{
Expand Down Expand Up @@ -361,15 +361,15 @@
"\n",
"**Note**: One thing to pay attention to with the slow waveform is batch size. This is determined by memory limits. Usually anything under ~10000 is fine.\n",
"\n",
"* Trajectory Module: [`RunSchwarzEccFluxInspiral`](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.trajectory.flux.RunSchwarzEccFluxInspiral)\n",
"* Trajectory Module: [RunSchwarzEccFluxInspiral](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.trajectory.flux.RunSchwarzEccFluxInspiral)\n",
"\n",
"* Amplitude Module: [`Interp2DAmplitude`](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.amplitude.interp2dcubicspline.Interp2DAmplitude)\n",
"* Amplitude Module: [Interp2DAmplitude](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.amplitude.interp2dcubicspline.Interp2DAmplitude)\n",
"\n",
"* Summation Module: [`DirectModeSum`](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.summation.directmodesum.DirectModeSum)\n",
"* Summation Module: [DirectModeSum](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.summation.directmodesum.DirectModeSum)\n",
"\n",
"* Mode Selection: None\n",
"\n",
"* Angular Harmonics: [`GetYlms`](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.ylm.GetYlms)\n"
"* Angular Harmonics: [GetYlms](https://mikekatz04.github.io/FastEMRIWaveforms/html/index.html#few.utils.ylm.GetYlms)\n"
]
},
{
Expand Down Expand Up @@ -1531,7 +1531,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"In addition to using our built-in modules and waveforms, you can easily create your own module or waveform. Below is an example of creating your own trajectory module and using it in a custom waveform. If you can get a reasonably fast trajectory from your specific brand of EMRI physics, you can be generating waveforms in no time! Please see the [documentation]() on this for more details on the constructions behind this. \n",
"In addition to using our built-in modules and waveforms, you can easily create your own module or waveform. Below is an example of creating your own trajectory module and using it in a custom waveform. If you can get a reasonably fast trajectory from your specific brand of EMRI physics, you can be generating waveforms in no time! Please see the [documentation](https://mikekatz04.github.io/FastEMRIWaveforms/) on this for more details on the constructions behind this. \n",
"\n",
"**Important Note**: If you do use this package to examine EMRI analysis problems, please contact the authors of this code (see docs) about possible collaboration and/or contribution."
]
Expand Down
Loading

0 comments on commit 0e0d1e7

Please sign in to comment.