Skip to content

Commit

Permalink
fixed to allow for google colab install
Browse files Browse the repository at this point in the history
  • Loading branch information
mikekatz04 committed Jan 3, 2025
1 parent e534356 commit 55de43b
Show file tree
Hide file tree
Showing 88 changed files with 316 additions and 172 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ This will install necessary packages for building the documentation (`sphinx`, `

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.5.5
Current Version: 1.5.11

## Authors/Developers

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/tutorial/FastEMRIWaveforms_tutorial.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/doctrees/tutorial/Tutorial_FrequencyDomain_Waveforms.doctree
Binary file not shown.
Binary file modified docs/doctrees/user/amp.doctree
Binary file not shown.
Binary file modified docs/doctrees/user/cite.doctree
Binary file not shown.
Binary file modified docs/doctrees/user/main.doctree
Binary file not shown.
Binary file modified docs/doctrees/user/pointer.doctree
Binary file not shown.
Binary file modified docs/doctrees/user/sum.doctree
Binary file not shown.
Binary file modified docs/doctrees/user/traj.doctree
Binary file not shown.
Binary file modified docs/doctrees/user/util.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
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: 1abcea7d474198d107de3ce8b98d87f5
config: f9f9164e6035234e4c133dede5ccc5cf
tags: 645f666f9bcd5a90fca523b33c5a78b7
18 changes: 10 additions & 8 deletions docs/html/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=01f34227"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></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>
Expand Down Expand Up @@ -165,7 +165,8 @@ <h3>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this
generally under 10MB. However, there is a 100MB file needed for the slow
waveform and the bicubic amplitude interpolation. This larger file will
only download if you run either of those two modules. The files are
hosted on <a class="reference external" href="https://zenodo.org/record/3981654#.XzS_KRNKjlw">Zenodo</a>.</p>
hosted on the <a class="reference external" href="https://download.bhptoolkit.org/few/data">Black Hole Perturbation Toolkit Download
Server</a>.</p>
</section>
<section id="installing">
<h3>Installing<a class="headerlink" href="#installing" title="Link to this heading"></a></h3>
Expand Down Expand Up @@ -225,13 +226,13 @@ <h3>More Customized Installation (legacy)<a class="headerlink" href="#more-custo
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">few_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">wget</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">hdf5</span> <span class="n">numpy</span> <span class="n">Cython</span> <span class="n">scipy</span> <span class="n">tqdm</span> <span class="n">jupyter</span> <span class="n">ipython</span> <span class="n">h5py</span> <span class="n">requests</span> <span class="n">matplotlib</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.7</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">few_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">wget</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">hdf5</span> <span class="n">numpy</span> <span class="n">Cython</span> <span class="n">scipy</span> <span class="n">tqdm</span> <span class="n">jupyter</span> <span class="n">ipython</span> <span class="n">h5py</span> <span class="n">requests</span> <span class="n">rich</span> <span class="n">matplotlib</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.7</span>
<span class="n">conda</span> <span class="n">activate</span> <span class="n">few_env</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>If on MACOSX, substitute `gcc_linux-64` and `gxx_linus-64` with `clang_osx-64` and `clangxx_osx-64`.

If you want a faster install, you can install the python packages (numpy, Cython, scipy, tqdm, jupyter, ipython, h5py, requests, matplotlib) with pip.
If you want a faster install, you can install the python packages (numpy, Cython, scipy, tqdm, jupyter, ipython, h5py, requests, rich, matplotlib) with pip.
</pre></div>
</div>
<ol class="arabic simple" start="2">
Expand All @@ -244,15 +245,16 @@ <h3>More Customized Installation (legacy)<a class="headerlink" href="#more-custo
<ol class="arabic simple" start="3">
<li><p>If using GPUs, use pip to <a class="reference external" href="https://docs-cupy.chainer.org/en/stable/install.html">install
cupy</a>. If
you have cuda version 9.2, for example:</p></li>
you have cuda version 12.1, for example:</p></li>
</ol>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">cupy</span><span class="o">-</span><span class="n">cuda92</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">cupy</span><span class="o">-</span><span class="n">cuda12x</span>
</pre></div>
</div>
<ol class="arabic simple" start="4">
<li><p>Run install.</p></li>
</ol>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">prebuild</span><span class="o">.</span><span class="n">py</span>
<span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
</pre></div>
</div>
<p>When installing lapack and gsl, the setup file will default to assuming
Expand Down Expand Up @@ -327,7 +329,7 @@ <h2>Versioning<a class="headerlink" href="#versioning" title="Link to this headi
<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.5.5</p>
<p>Current Version: 1.5.11</p>
</section>
<section id="authors-developers">
<h2>Authors/Developers<a class="headerlink" href="#authors-developers" title="Link to this heading"></a></h2>
Expand Down
14 changes: 8 additions & 6 deletions docs/html/_sources/README.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ will download automatically the first time they are needed. Files are
generally under 10MB. However, there is a 100MB file needed for the slow
waveform and the bicubic amplitude interpolation. This larger file will
only download if you run either of those two modules. The files are
hosted on `Zenodo <https://zenodo.org/record/3981654#.XzS_KRNKjlw>`__.
hosted on the `Black Hole Perturbation Toolkit Download
Server <https://download.bhptoolkit.org/few/data>`__.

Installing
~~~~~~~~~~
Expand Down Expand Up @@ -146,14 +147,14 @@ More Customized Installation (legacy)

::

conda create -n few_env -c conda-forge gcc_linux-64 gxx_linux-64 wget gsl lapack=3.6.1 hdf5 numpy Cython scipy tqdm jupyter ipython h5py requests matplotlib python=3.7
conda create -n few_env -c conda-forge gcc_linux-64 gxx_linux-64 wget gsl lapack=3.6.1 hdf5 numpy Cython scipy tqdm jupyter ipython h5py requests rich matplotlib python=3.7
conda activate few_env

::

If on MACOSX, substitute `gcc_linux-64` and `gxx_linus-64` with `clang_osx-64` and `clangxx_osx-64`.

If you want a faster install, you can install the python packages (numpy, Cython, scipy, tqdm, jupyter, ipython, h5py, requests, matplotlib) with pip.
If you want a faster install, you can install the python packages (numpy, Cython, scipy, tqdm, jupyter, ipython, h5py, requests, rich, matplotlib) with pip.

2) Clone the repository.

Expand All @@ -164,16 +165,17 @@ More Customized Installation (legacy)

3) If using GPUs, use pip to `install
cupy <https://docs-cupy.chainer.org/en/stable/install.html>`__. If
you have cuda version 9.2, for example:
you have cuda version 12.1, for example:

::

pip install cupy-cuda92
pip install cupy-cuda12x

4) Run install.

::

python scripts/prebuild.py
python setup.py install

When installing lapack and gsl, the setup file will default to assuming
Expand Down Expand Up @@ -260,7 +262,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.5.5
Current Version: 1.5.11

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

- 1.5.5: pip installable.
- 1.5.11: pip installable.
- 1.5.4: Slight bug fix on creating ``few`` file directory.
- 1.5.3: openmp removed from change file. Temporary removal of zenodo record dictionary.
- 1.5.1: Added FD waveform. Removed an ``exp`` computation. Made module pickeable. Updated install.
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Base JavaScript utilities for all Sphinx HTML documentation.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
4 changes: 2 additions & 2 deletions docs/html/_static/language_data.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];


/* Non-minified version is copied as a separate JS file, is available */
/* Non-minified version is copied as a separate JS file, if available */

/**
* Porter Stemmer
Expand Down
Loading

0 comments on commit 55de43b

Please sign in to comment.