diff --git a/docs/index.rst b/docs/index.rst index 53dc58f..320cd62 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 `__ 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 `_. Installation ============