Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 23 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,32 @@ To see the latest changes in ``radiospectra`` see our `changelog <https://docs.s
Installation
============

The recommended way to install ``radiospectra`` is with `miniforge <https://github.com/conda-forge/miniforge#miniforge3>`__.
To install ``radiospectra`` once miniforge is installed run the following command:
Standard Installation
---------------------
The recommended way to install ``radiospectra`` is via pip:

.. code:: bash
.. code-block:: bash

$ conda install radiospectra
pip install radiospectra

Development Setup
-----------------
If you want to contribute to the development of ``radiospectra``, please follow these steps:

1. **Prerequisites**: We recommend using ``miniforge`` or ``conda`` to manage dependencies. Please refer to the official `SunPy Conda Guide <https://docs.sunpy.org/en/latest/dev_guide/contents/conda_for_dependencies.html>`_ for detailed environment setup.

2. **Editable Install**: Clone the repository and install it in editable mode:

.. code-block:: bash

pip install -e ".[dev,docs]"

3. **Verify Installation**: Run the tests to ensure everything is working correctly:

.. code-block:: bash

pytest

For detailed installation instructions, see the `installation guide <https://docs.sunpy.org/en/stable/guide/installation.html>`__ in the ``sunpy`` docs.

Getting Help
============
Expand Down
1 change: 1 addition & 0 deletions changelog/170.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added a "Development Setup" section to the README to assist new contributors.
Loading