
<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

    <title>kerrgeodesic_gw Reference Manual &#8212; kerrgeodesic_gw 0.4.1 documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
    
    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Kerr spacetime" href="kerr_spacetime.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="kerr_spacetime.html" title="Kerr spacetime"
             accesskey="N">next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">kerrgeodesic_gw 0.4.1 documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">kerrgeodesic_gw Reference Manual</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <section id="kerrgeodesic-gw-reference-manual">
<h1>kerrgeodesic_gw Reference Manual<a class="headerlink" href="#kerrgeodesic-gw-reference-manual" title="Permalink to this headline">¶</a></h1>
<p>This is the reference manual of the <a class="reference external" href="http://www.sagemath.org">SageMath</a>
package
<a class="reference external" href="https://github.com/BlackHolePerturbationToolkit/kerrgeodesic_gw">kerrgeodesic_gw</a>.</p>
<p>See this <a class="reference external" href="https://github.com/BlackHolePerturbationToolkit/kerrgeodesic_gw/blob/master/README.md">page</a> for the installation instructions and the article <a class="reference external" href="http://arxiv.org/abs/1903.02049">Arxiv 1903.02049</a> for details about
the implemented formulas.</p>
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="kerr_spacetime.html">Kerr spacetime</a></li>
<li class="toctree-l1"><a class="reference internal" href="kerr_geodesic.html">Geodesics in Kerr spacetime</a></li>
<li class="toctree-l1"><a class="reference internal" href="spher_harm.html">Spherical and spheroidal harmonics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="spin_weighted_spherical_harm.html">Spin-weighted spherical harmonics</a></li>
<li class="toctree-l2"><a class="reference internal" href="spin_weighted_spheroidal_harm.html">Spin-weighted spheroidal harmonics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="zinf.html">Amplitude factors <span class="math notranslate nohighlight">$Z^\infty_{\ell m}(r)$</span></a></li>
<li class="toctree-l1"><a class="reference internal" href="gw_particle.html">Gravitational radiation by a single particle</a></li>
<li class="toctree-l1"><a class="reference internal" href="gw_blob.html">Gravitational radiation by a blob of matter</a></li>
<li class="toctree-l1"><a class="reference internal" href="lisa_detector.html">LISA Detector</a></li>
<li class="toctree-l1"><a class="reference internal" href="signal_processing.html">Signal processing</a></li>
<li class="toctree-l1"><a class="reference internal" href="astro_data.html">Astronomical data</a></li>
<li class="toctree-l1"><a class="reference internal" href="utilities.html">Utilities</a></li>
</ul>
</div>
</section>
<section id="indices-and-tables">
<h2>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</section>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="#">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">kerrgeodesic_gw Reference Manual</a><ul>
<li><a class="reference internal" href="#contents">Contents</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and Tables</a></li>
</ul>
</li>
</ul>

  <h4>Next topic</h4>
  <p class="topless"><a href="kerr_spacetime.html"
                        title="next chapter">Kerr spacetime</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/index.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="kerr_spacetime.html" title="Kerr spacetime"
             >next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">kerrgeodesic_gw 0.4.1 documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">kerrgeodesic_gw Reference Manual</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2019-2021, Eric Gourgoulhon, Alexandre Le Tiec, Frederic Vincent, Niels Warburton.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.0.1.
    </div>
  </body>
</html>

Collaborative Calculation and Data Science

colby

sagemath

github

google

cornellcollege

depaul

Reference manual of the SageMath package kerrgeodesic_gw

Product

Resources

Company