Merge pull request #255 from dstansby/perf-doc

Improve performance docs

doc/source/index.rst

@@ -22,6 +22,14 @@ pfsspy can be installed from PyPi using
 
     pip install pfsspy
 
+This will install pfsspy and all of its dependencies. In addition to the core
+dependencies, there are two optional dependencies (numba, streamtracer) that
+improve code performance. These can be installed with
+
+.. code::
+
+    pip install pfsspy[performance]
+
 Citing
 ------
 

doc/source/performance.rst

@@ -3,14 +3,17 @@ Improving performance
 
 numba
 ~~~~~
-pfsspy automatically detects an installation of
-`numba <https://numba.pydata.org/>`_, which compiles
+pfsspy automatically detects an installation of `numba`_, which compiles
 some of the numerical code to speed up pfss calculations. To enable this
-simply `install numba <http://numba.pydata.org/numba-doc/latest/user/installing.html>`_
-and use pfsspy as normal.
+simply `install numba`_  and use pfsspy as normal.
 
 Streamline tracing
 ~~~~~~~~~~~~~~~~~~
 pfsspy has two streamline tracers: a pure python `pfsspy.tracing.PythonTracer`
 and a FORTRAN `pfsspy.tracing.FortranTracer`. The FORTRAN version is
-significantly faster.
+significantly faster, using the `streamtracer`_ package.
+
+
+.. _numba: https://numba.pydata.org
+.. _install numba: http://numba.pydata.org/numba-doc/latest/user/installing.html
+.. _streamtracer: https://github.com/dstansby/streamtracer

setup.cfg

@@ -57,6 +57,9 @@ test =
   pytest-cov
   streamtracer
   reproject
+performance =
+  numba
+  streamtracer
 
 # See the docstring in versioneer.py for instructions. Note that you must
 # re-run 'versioneer.py setup' after changing this section, and commit the