Skip to content

Commit

Permalink
Merge pull request #52 from Cadair/install_docs
Browse files Browse the repository at this point in the history
Update the install docs to link to sunpy core
  • Loading branch information
Cadair authored Jun 10, 2024
2 parents 913d854 + d81766e commit 902b8c1
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,22 @@
Installing
**********

``sunkit_magex`` can be installed from PyPI using
If you need to install Python, you should start by following the :external+sunpy:ref:`sunpy core installation guide <sunpy-tutorial-installing>`.

``sunkit-magex`` can then be installed with conda:

.. code:: shell
conda install -c conda-forge sunkit-magex
Alternatively ``sunkit-magex`` can be installed from PyPI using:

.. code:: shell
pip install sunkit-magex
This will install sunkit_magex and all of its dependencies.
In addition to the core dependencies, there are two optional dependencies (numba, streamtracer) that can improve code performance.
In addition to the core dependencies, there are optional dependencies (numba, streamtracer) that can improve code performance.
These can be installed with

.. code:: shell
Expand Down

0 comments on commit 902b8c1

Please sign in to comment.