From 791f89f701149abf14c693c875b142dac98952b8 Mon Sep 17 00:00:00 2001 From: Monier Ayman Date: Fri, 27 Feb 2026 20:27:17 +0200 Subject: [PATCH 1/4] Update overview.rst DOC: Improve overview.rst with narrative and quick start example - Adds a clear description of radiospectra - Lists supported instruments with official names - Adds verified Quick Start example for e-CALLISTO - Explains workflow in plain English --- docs/overview.rst | 66 ++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 57 insertions(+), 9 deletions(-) diff --git a/docs/overview.rst b/docs/overview.rst index d06aeec1..62379aad 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,12 +1,60 @@ -******** Overview -******** +======== -``radiospectra`` currently supports reading spectra from: +radiospectra is a Python package for reading and working with +solar and heliospheric radio spectrogram data. It provides a +common interface for loading dynamic spectra from multiple +radio instruments and representing them as spectrogram objects. -- e-CALISTO -- Extend Owen Valley Array -- Parker Solar Probe FIELDS/Radio Frequency Spectrometer -- Radio Solar Telescope Network -- STEREO Waves -- Wind Waves +Spectrogram data are represented using a unified object model, +allowing users to inspect metadata, access intensity data, +and generate visualizations in a consistent way across +different instruments. + +Supported Instruments +--------------------- + +radiospectra currently supports spectrogram data from: + +- e-CALLISTO +- Expanded Owens Valley Solar Array (EOVSA) +- Parker Solar Probe FIELDS/RFS +- Radio Solar Telescope Network (RSTN) +- STEREO/WAVES +- Wind/WAVES + +Quick Start +----------- + +The example below demonstrates how to search, download, +and plot e-CALLISTO spectrogram data. + +.. code-block:: python + + import radiospectra.net + from sunpy.net import Fido, attrs as a + from radiospectra.spectrogram import Spectrogram + from radiospectra.net import attrs as ra + + # Search for e-CALLISTO data + query = Fido.search( + a.Time('2019/10/05 23:00', '2019/10/06 00:59'), + a.Instrument('eCALLISTO'), + ra.Observatory('ALASKA') + ) + + # Download the first result + downloaded = Fido.fetch(query[0][0]) + + # Create a spectrogram object + spec = Spectrogram(downloaded[0]) + + # Plot the spectrogram + spec.plot() + +This workflow: + +- Searches the e-CALLISTO archive +- Downloads a spectrogram file +- Loads it into a Spectrogram object +- Displays a frequency–time intensity plot From 90a34573496e85e281dad7c9681b1e2dfb677fc6 Mon Sep 17 00:00:00 2001 From: Monier Ayman Date: Fri, 27 Feb 2026 20:40:48 +0200 Subject: [PATCH 2/4] DOC: Add changelog for overview.rst update --- changelog/2026-02-27-overview-update.rst | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 changelog/2026-02-27-overview-update.rst diff --git a/changelog/2026-02-27-overview-update.rst b/changelog/2026-02-27-overview-update.rst new file mode 100644 index 00000000..7b05cd82 --- /dev/null +++ b/changelog/2026-02-27-overview-update.rst @@ -0,0 +1,8 @@ +Overview Documentation Update +============================= + +- Improved the Overview section of the documentation (overview.rst) +- Added a clear description of radiospectra +- Listed all supported instruments with official names +- Added a verified Quick Start example for e-CALLISTO using the public Spectrogram API +- Explained the workflow in plain English for new users \ No newline at end of file From 0a17b6e14bee442546d81fed9e9a4f96e94ab447 Mon Sep 17 00:00:00 2001 From: Monier Ayman Date: Fri, 27 Feb 2026 20:45:19 +0200 Subject: [PATCH 3/4] Fix changelog filename to match PR #165 --- changelog/{2026-02-27-overview-update.rst => 165.doc.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename changelog/{2026-02-27-overview-update.rst => 165.doc.rst} (100%) diff --git a/changelog/2026-02-27-overview-update.rst b/changelog/165.doc.rst similarity index 100% rename from changelog/2026-02-27-overview-update.rst rename to changelog/165.doc.rst From 4b14a4223861c3299231a53b7e5e721c8652a10b Mon Sep 17 00:00:00 2001 From: Monier Ayman Date: Fri, 27 Feb 2026 20:52:06 +0200 Subject: [PATCH 4/4] Add final newline to changelog for pre-commit CI --- changelog/165.doc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog/165.doc.rst b/changelog/165.doc.rst index 7b05cd82..6bc5aa47 100644 --- a/changelog/165.doc.rst +++ b/changelog/165.doc.rst @@ -5,4 +5,4 @@ Overview Documentation Update - Added a clear description of radiospectra - Listed all supported instruments with official names - Added a verified Quick Start example for e-CALLISTO using the public Spectrogram API -- Explained the workflow in plain English for new users \ No newline at end of file +- Explained the workflow in plain English for new users