Skip to content

Commit

Permalink
updated and fixed a few issues
Browse files Browse the repository at this point in the history
  • Loading branch information
mkatz authored and mkatz committed Mar 31, 2023
1 parent 655b4f2 commit 68457df
Show file tree
Hide file tree
Showing 44 changed files with 1,499 additions and 3,185 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,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/mikekatz04/BBHx/tags).

Current Version: 1.0.3
Current Version: 1.0.4

## Authors

Expand Down
Binary file modified docs/doctrees/README.doctree
View file
Binary file not shown.
Binary file modified docs/doctrees/bbhx_tutorial.doctree
View file
Binary file not shown.
Binary file modified docs/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/doctrees/user/constants.doctree
View file
Binary file not shown.
Binary file modified docs/doctrees/user/like.doctree
View file
Binary file not shown.
Binary file modified docs/doctrees/user/main.doctree
View file
Binary file not shown.
Binary file modified docs/doctrees/user/response.doctree
View file
Binary file not shown.
Binary file modified docs/doctrees/user/utils.doctree
View file
Binary file not shown.
Binary file modified docs/doctrees/user/waveforms.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: c09bcceb705964b7b0149cd237115a92
config: c6fda011b514044edda33d31641da3c8
tags: 645f666f9bcd5a90fca523b33c5a78b7
77 changes: 29 additions & 48 deletions docs/html/README.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>GPU-Accelerated Black Hole Binary Waveforms (bbhx) &mdash; bbhx documentation</title>
Expand All @@ -11,10 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<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/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
Expand All @@ -26,11 +27,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: coral" >
<a href="index.html" class="icon icon-home"> bbhx



<a href="index.html" class="icon icon-home">
bbhx
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
Expand Down Expand Up @@ -68,8 +73,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>GPU-Accelerated Black Hole Binary Waveforms (<code class="docutils literal notranslate"><span class="pre">bbhx</span></code>)</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">GPU-Accelerated Black Hole Binary Waveforms (<code class="docutils literal notranslate"><span class="pre">bbhx</span></code>)</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/README.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand All @@ -79,34 +84,10 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">


<style>
/* CSS overrides for sphinx_rtd_theme */

/* 24px margin */
.nbinput.nblast.container,
.nboutput.nblast.container {
margin-bottom: 19px; /* padding has already 5px */
}

/* ... except between code cells! */
.nblast.container + .nbinput.container {
margin-top: -19px;
}

.admonition > p:before {
margin-right: 4px; /* make room for the exclamation icon */
}

/* Fix math alignment, see https://github.com/rtfd/sphinx_rtd_theme/pull/686 */
.math {
text-align: unset;
}
</style>
<section id="gpu-accelerated-black-hole-binary-waveforms-bbhx">
<h1>GPU-Accelerated Black Hole Binary Waveforms (<code class="docutils literal notranslate"><span class="pre">bbhx</span></code>)<a class="headerlink" href="#gpu-accelerated-black-hole-binary-waveforms-bbhx" title="Permalink to this headline"></a></h1>
<section id="gpu-accelerated-black-hole-binary-waveforms-bbhx">
<h1>GPU-Accelerated Black Hole Binary Waveforms (<code class="docutils literal notranslate"><span class="pre">bbhx</span></code>)<a class="headerlink" href="#gpu-accelerated-black-hole-binary-waveforms-bbhx" title="Permalink to this heading"></a></h1>
<section id="designed-for-lisa-data-analysis-of-massive-black-hole-binaries">
<h2>Designed for LISA data analysis of Massive Black Hole Binaries.<a class="headerlink" href="#designed-for-lisa-data-analysis-of-massive-black-hole-binaries" title="Permalink to this headline"></a></h2>
<h2>Designed for LISA data analysis of Massive Black Hole Binaries.<a class="headerlink" href="#designed-for-lisa-data-analysis-of-massive-black-hole-binaries" title="Permalink to this heading"></a></h2>
<p>This package implements GPU/CPU agnostic Massive Black Hole Binary
waveforms and likelihood computations from
<a class="reference external" href="https://arxiv.org/abs/2005.01827">arXiv:2005.01827</a> and
Expand All @@ -127,7 +108,7 @@ <h2>Designed for LISA data analysis of Massive Black Hole Binaries.<a class="hea
See the <code class="docutils literal notranslate"><span class="pre">citation</span></code> attribute for each class or docstring for functions
for more information.</p>
<section id="getting-started">
<h3>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h3>
<h3>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this heading"></a></h3>
<p>Below is a quick set of instructions to get you started with <code class="docutils literal notranslate"><span class="pre">bbhx</span></code>.</p>
<ol class="arabic simple" start="0">
<li><p><a class="reference external" href="https://docs.anaconda.com/anaconda/install/">Install Anaconda</a> if
Expand All @@ -137,7 +118,7 @@ <h3>Getting Started<a class="headerlink" href="#getting-started" title="Permalin
you will probably need to add libraries and include paths to the
<code class="docutils literal notranslate"><span class="pre">setup.py</span></code> file.</p></li>
</ol>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">bbhx_env</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">gcc_linux</span><span class="o">-</span><span class="mi">64</span> <span class="n">gxx_linux</span><span class="o">-</span><span class="mi">64</span> <span class="n">gsl</span> <span class="n">lapack</span><span class="o">=</span><span class="mf">3.6</span><span class="o">.</span><span class="mi">1</span> <span class="n">numpy</span> <span class="n">scipy</span> <span class="n">Cython</span> <span class="n">jupyter</span> <span class="n">ipython</span> <span class="n">matplotlib</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.9</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">bbhx_env</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">gcc_linux</span><span class="o">-</span><span class="mi">64</span> <span class="n">gxx_linux</span><span class="o">-</span><span class="mi">64</span> <span class="n">gsl</span> <span class="n">lapack</span><span class="o">=</span><span class="mf">3.6.1</span> <span class="n">numpy</span> <span class="n">scipy</span> <span class="n">Cython</span> <span class="n">jupyter</span> <span class="n">ipython</span> <span class="n">matplotlib</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.9</span>
<span class="n">conda</span> <span class="n">activate</span> <span class="n">bbhx_env</span>
</pre></div>
</div>
Expand All @@ -147,7 +128,7 @@ <h3>Getting Started<a class="headerlink" href="#getting-started" title="Permalin
<ol class="arabic simple" start="2">
<li><p>Clone the repository.</p></li>
</ol>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">mikekatz04</span><span class="o">.</span><span class="n">github</span><span class="o">.</span><span class="n">io</span><span class="o">/</span><span class="n">BBHx</span><span class="o">.</span><span class="n">git</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">mikekatz04</span><span class="o">/</span><span class="n">BBHx</span><span class="o">.</span><span class="n">git</span>
<span class="n">cd</span> <span class="n">BBHx</span>
</pre></div>
</div>
Expand All @@ -168,7 +149,7 @@ <h3>Getting Started<a class="headerlink" href="#getting-started" title="Permalin
</section>
</section>
<section id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this heading"></a></h2>
<p>To install this software for CPU usage, you need <a class="reference external" href="https://www.gnu.org/software/gsl/">gsl
&gt;2.0</a> , <a class="reference external" href="https://www.netlib.org/lapack/lug/node14.html">lapack
(3.6.1)</a>, Python &gt;3.4,
Expand All @@ -190,13 +171,13 @@ <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to
it as the <code class="docutils literal notranslate"><span class="pre">CUDAHOME</span></code> environment variable.</p>
</section>
<section id="installing">
<h2>Installing<a class="headerlink" href="#installing" title="Permalink to this headline"></a></h2>
<h2>Installing<a class="headerlink" href="#installing" title="Permalink to this heading"></a></h2>
<ol class="arabic simple" start="0">
<li><p><a class="reference external" href="https://docs.anaconda.com/anaconda/install/">Install Anaconda</a> if
you do not have it.</p></li>
<li><p>Create a virtual environment.</p></li>
</ol>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">bbhx_env</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">gcc_linux</span><span class="o">-</span><span class="mi">64</span> <span class="n">gxx_linux</span><span class="o">-</span><span class="mi">64</span> <span class="n">gsl</span> <span class="n">lapack</span><span class="o">=</span><span class="mf">3.6</span><span class="o">.</span><span class="mi">1</span> <span class="n">numpy</span> <span class="n">scipy</span> <span class="n">Cython</span> <span class="n">jupyter</span> <span class="n">ipython</span> <span class="n">matplotlib</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.9</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">bbhx_env</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">gcc_linux</span><span class="o">-</span><span class="mi">64</span> <span class="n">gxx_linux</span><span class="o">-</span><span class="mi">64</span> <span class="n">gsl</span> <span class="n">lapack</span><span class="o">=</span><span class="mf">3.6.1</span> <span class="n">numpy</span> <span class="n">scipy</span> <span class="n">Cython</span> <span class="n">jupyter</span> <span class="n">ipython</span> <span class="n">matplotlib</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.9</span>
<span class="n">conda</span> <span class="n">activate</span> <span class="n">bbhx_env</span>
</pre></div>
</div>
Expand Down Expand Up @@ -260,44 +241,44 @@ <h2>Installing<a class="headerlink" href="#installing" title="Permalink to this
</pre></div>
</div>
<section id="running-the-tests">
<h3>Running the Tests<a class="headerlink" href="#running-the-tests" title="Permalink to this headline"></a></h3>
<h3>Running the Tests<a class="headerlink" href="#running-the-tests" title="Permalink to this heading"></a></h3>
<p>In the main directory of the package run in the terminal:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">unittest</span> <span class="n">discover</span>
</pre></div>
</div>
</section>
<section id="contributing">
<h3>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline"></a></h3>
<h3>Contributing<a class="headerlink" href="#contributing" title="Permalink to this heading"></a></h3>
<p>Please read <a class="reference external" href="CONTRIBUTING.md">CONTRIBUTING.md</a> for details on our
code of conduct, and the process for submitting pull requests to us.</p>
</section>
<section id="versioning">
<h3>Versioning<a class="headerlink" href="#versioning" title="Permalink to this headline"></a></h3>
<h3>Versioning<a class="headerlink" href="#versioning" title="Permalink to this heading"></a></h3>
<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/mikekatz04/BBHx/tags">tags on this
repository</a>.</p>
<p>Current Version: 1.0.3</p>
<p>Current Version: 1.0.4</p>
</section>
<section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h3>
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><strong>Michael Katz</strong></p></li>
</ul>
</section>
</section>
<section id="contibutors">
<h2>Contibutors<a class="headerlink" href="#contibutors" title="Permalink to this headline"></a></h2>
<h2>Contibutors<a class="headerlink" href="#contibutors" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>Sylvain Marsat</p></li>
<li><p>John Baker</p></li>
</ul>
<section id="license">
<h3>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h3>
<h3>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h3>
<p>This project is licensed under the GNU License - see the
<a class="reference external" href="LICENSE.md">LICENSE.md</a> file for details.</p>
</section>
<section id="acknowledgments">
<h3>Acknowledgments<a class="headerlink" href="#acknowledgments" title="Permalink to this headline"></a></h3>
<h3>Acknowledgments<a class="headerlink" href="#acknowledgments" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>This research was also supported in part through the computational
resources and staff contributions provided for the Quest/Grail high
Expand Down
4 changes: 2 additions & 2 deletions docs/html/_sources/README.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Below is a quick set of instructions to get you started with ``bbhx``.

::

git clone https://mikekatz04.github.io/BBHx.git
git clone https://github.com/mikekatz04/BBHx.git
cd BBHx

3) Run install.
Expand Down Expand Up @@ -191,7 +191,7 @@ We use `SemVer <http://semver.org/>`__ for versioning. For the versions
available, see the `tags on this
repository <https://github.com/mikekatz04/BBHx/tags>`__.

Current Version: 1.0.3
Current Version: 1.0.4

Authors
-------
Expand Down
Loading

0 comments on commit 68457df

Please sign in to comment.