Skip to content

Update docs to remove warning about development #244

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

Merged
samaloney merged 2 commits into from
Jun 30, 2026
Merged

Update docs to remove warning about development #244

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e813529
updating the wanring
Jun 25, 2026
a7a18d6
fixing warnign to note
Jun 25, 2026
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
15 changes: 5 additions & 10 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,13 @@
radiospectra Documentation
**************************

``radiospectra`` is a Python software package that provides support for some type of radio spectra in solar physics.
``radiospectra`` is a Python package for reading, storing, and visualising dynamic radio spectra in heliophysics, from both ground- and space-based instruments.

.. warning::
.. note::

``radiospectra`` is currently undergoing a transition.
We have replaced the old spectragram class with a new one which is lacking in some features.

We also have to decide on the fututre of the ``radiospectra`` package.
This package does not see heavy development and is not used by many people.
It is also not clear what the future of radio spectra within the SunPy Project is going to be.
In addition, ``xarray`` or similar packages could offer a better data handling solution than the current ``radiospectra`` package.
We need and want users (of radio data in general) to chime in and to help us decide the future of this package.
``radiospectra`` is under active redevelopment, with more functionality and instrument support coming soon.
The package is moving to build on `ndcube <https://docs.sunpy.org/projects/ndcube/>`__ under the hood, giving a coordinate-aware container for dynamic spectra that is consistent across instruments and with the wider SunPy ecosystem.
We welcome feedback from anyone working with radio data, if you use dynamic spectra, please get in touch via the `SunPy Chat <https://openastronomy.element.io/#/room/#sunpy:openastronomy.org>`_.

Installation
============
Expand Down
Loading