diff --git a/README.rst b/README.rst index 22aec6b9..be6a1082 100644 --- a/README.rst +++ b/README.rst @@ -25,8 +25,8 @@ .. |Project Status: Active| image:: https://www.repostatus.org/badges/latest/active.svg :target: https://www.repostatus.org/#active -.. |Zenodo - Latest DOI| image:: https://zenodo.org/badge/175066331.svg - :target: https://zenodo.org/doi/10.5281/zenodo.11526911 +.. |Zenodo - Latest DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.11526911.svg + :target: https://doi.org/10.5281/zenodo.11526911 .. |Continuous Integration Status| image:: https://github.com/sunpy/sunkit-spex/actions/workflows/ci.yml/badge.svg?branch=main :target: https://github.com/sunpy/sunkit-spex/actions/workflows/ci.yml @@ -52,8 +52,14 @@ For more information see our documentation on fair and appropriate `AI usage `__. +.. code-block:: + + $ pip install sunkit-spex + $ pip install sunkit-spex[legacy] # with optional legacy dependencies + +For more details and development installs see the `installation guide `__. If you are new to ``sunkit-spex``, the best place to start is the `example gallery `__ it includes a collection of short, specific examples of using ``sunkit-spex``. diff --git a/docs/tutorials/installation.rst b/docs/tutorials/installation.rst index 223d5fcc..299807d5 100644 --- a/docs/tutorials/installation.rst +++ b/docs/tutorials/installation.rst @@ -4,9 +4,24 @@ Installing sunkit-spex ********************** +Installing the release version +------------------------------ + +To install the current release version of ``sunkit-spex`` use pip + +.. code-block:: + + $ pip install sunkit-spex + +or with the legacy optional dependency which are needed to use the legacy fitting code and examples + +.. code-block:: + + $ pip install sunkit-spex[legacy] + Installing the development version ---------------------------------- -Sunkit-spex is still under development, and no stable version has been released. However, users can install the the development version. +``sunkit-spex`` is still under development, and no stable version has been released. However, users can install the the development version. Detailed instructions for setting up a development environment, as well as a discussion on how to contribute code to any SunPy package, can be found in the `Developer's Guide `__. We highly encourage users to read this, especially if considering contributing to sunkit-spex (which we welcome enthusiastically!) For brevity though, the key installation steps are as follows.