Merge pull request #6 from BlackHolePerturbationToolkit/format

Added conda-forge instructions and reformatted code
BlackHolePerturbationToolkit · Dec 12, 2023 · 3f70913 · 3f70913
2 parents 296e016 + 0f8e8b4
commit 3f70913
Show file tree

Hide file tree

Showing 20 changed files with 4,134 additions and 2,476 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 [![GitHub release (with filter)](https://img.shields.io/github/v/release/BlackHolePerturbationToolkit/KerrGeoPy)](https://github.com/BlackHolePerturbationToolkit/KerrGeoPy/releases)
 [![Test Status](https://github.com/BlackHolePerturbationToolkit/KerrGeoPy/actions/workflows/tests.yml/badge.svg)](https://github.com/BlackHolePerturbationToolkit/KerrGeoPy/actions)
 [![PyPI - Version](https://img.shields.io/pypi/v/kerrgeopy)](https://pypi.org/project/kerrgeopy/)
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/kerrgeopy.svg)](https://anaconda.org/conda-forge/kerrgeopy)
 [![Documentation Status](https://readthedocs.org/projects/kerrgeopy/badge/?version=latest)](https://kerrgeopy.readthedocs.io/en/latest/?badge=latest)
 [![GitHub License](https://img.shields.io/github/license/BlackHolePerturbationToolkit/KerrGeoPy)](https://github.com/BlackHolePerturbationToolkit/KerrGeoPy/blob/main/LICENSE)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10126824.svg)](https://doi.org/10.5281/zenodo.10126824)
@@ -11,19 +12,22 @@ KerrGeoPy is a python implementation of the [KerrGeodesics](https://bhptoolkit.o
 
 ## Installation
 
-Install the latest version of kerrgeopy using pip
-
+Install using Anaconda
+```bash
+conda install -c conda-forge kerrgeopy
+```
+or using pip
 ```bash
 pip install kerrgeopy
 ```
 
 > **Note**
 >
-> KerrGeoPy uses functions introduced in scipy 1.8, so it may also be necessary to update scipy by running `pip install scipy -U`, although in most cases this should be done automatically by pip. Certain plotting and animation functions also make use of features introduced in matplotlib 3.7 and rely on [ffmpeg](https://ffmpeg.org/download.html), which can be easily installed using [homebrew](https://formulae.brew.sh/formula/ffmpeg) or [anaconda](https://anaconda.org/conda-forge/ffmpeg).
+> This library uses functions introduced in scipy 1.8, so it may also be necessary to update scipy by running `pip install scipy -U`, although in most cases this should be done automatically by pip. Certain plotting and animation functions also make use of features introduced in matplotlib 3.7 and rely on [ffmpeg](https://ffmpeg.org/download.html), which can be easily installed using [homebrew](https://formulae.brew.sh/formula/ffmpeg) or [anaconda](https://anaconda.org/conda-forge/ffmpeg).
 
 ## Stable Bound Orbits
 
-Kerrgeopy computes orbits in Boyer-Lindquist coordinates $(t,r,\theta,\phi)$. Let $M$ to represent the mass of the primary body and let $J$ represent its angular momentum. Working in geometrized units where $G=c=1$, stable bound orbits are parametrized using the following variables:
+KerrGeoPy computes orbits in Boyer-Lindquist coordinates $(t,r,\theta,\phi)$. Let $M$ to represent the mass of the primary body and let $J$ represent its angular momentum. Working in geometrized units where $G=c=1$, stable bound orbits are parametrized using the following variables:
 
 $a$ - spin of the primary body
 <br>

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -34,8 +34,10 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "myst_nb",
-    "sphinx.ext.viewcode"
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
 ]
+napoleon_use_ivar = True
 myst_enable_extensions = ["dollarmath", "amsmath"]
 nb_execution_mode = "off"
 autosummary_generate = True

diff --git a/docs/source/images/thumbnail.gif b/docs/source/images/thumbnail.gif
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,19 +14,21 @@ The library also provides a set of methods for computing constants of motion and
     :align: left
     :width: 45%
 
-.. https://github.com/sphinx-doc/sphinx/issues/823
-
-.. raw:: html
-
-   <video width="45%" autoplay loop>
-      <source src="https://cdn.jsdelivr.net/gh/BlackHolePerturbationToolkit/KerrGeoPy@main/docs/source/notebooks/animation4.mp4" type="video/mp4">
-   </video>
+.. image:: images/thumbnail.gif
+    :align: right
+    :width: 45%
 
 .. _Installation:
 
 Installation
 ------------
-Install the latest version of kerrgeopy using pip
+Install using Anaconda
+
+.. code-block:: bash
+
+   conda install -c conda-forge kerrgeopy
+
+or using pip
 
 .. code-block:: bash
 

diff --git a/docs/source/notebooks/Getting Started.ipynb b/docs/source/notebooks/Getting Started.ipynb
@@ -7,13 +7,6 @@
    "source": [
     "# Getting Started\n",
     "\n",
-    "## Installation\n",
-    "\n",
-    "Install the latest version of kerrgeopy using pip\n",
-    "\n",
-    "```bash\n",
-    "pip install kerrgeopy\n",
-    "```\n",
     "(stable-orbits)=\n",
     "## Stable Bound Orbits\n",
     "\n",

diff --git a/docs/source/notebooks/Trajectory.ipynb b/docs/source/notebooks/Trajectory.ipynb