Skip to content

Post release doc updates #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samaloney wants to merge 1 commit into
base: main
Choose a base branch
from
+25 −4
Open

Post release doc updates #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -52,8 +52,14 @@ For more information see our documentation on fair and appropriate `AI usage <ht

Installation
------------
To install the latest release use pip or your package managers equivalent.

See the `installation guide <https://sunkit-spex.readthedocs.io/en/latest/tutorials/installation.html>`__.
.. 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 <https://sunkit-spex.readthedocs.io/en/latest/tutorials/installation.html>`__.

If you are new to ``sunkit-spex``, the best place to start is the `example gallery <https://sunkit-spex.readthedocs.io/en/latest/generated/gallery/index.html>`__ it includes a collection of short, specific examples of using ``sunkit-spex``.

Expand Down
17 changes: 16 additions & 1 deletion docs/tutorials/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.sunpy.org/en/latest/dev_guide/index.html#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.
Expand Down