diff --git a/changelog/173.doc.rst b/changelog/173.doc.rst new file mode 100644 index 00000000..6bbd4be3 --- /dev/null +++ b/changelog/173.doc.rst @@ -0,0 +1 @@ +Created docstring examples for ``RPWSpectrogram`` data. diff --git a/radiospectra/spectrogram/sources/rpw.py b/radiospectra/spectrogram/sources/rpw.py index 50c9face..e6c828de 100644 --- a/radiospectra/spectrogram/sources/rpw.py +++ b/radiospectra/spectrogram/sources/rpw.py @@ -5,12 +5,14 @@ class RPWSpectrogram(GenericSpectrogram): """ - Solar Orbiter Radio and Plasma Waves (RPW) RPW-HFR-SURV spectrogram. + Solar Orbiter Radio and Plasma Waves (RPW) spectrogram. - For more information on the instrument see ``__. + For more information on the instrument see ``__. + + Examples for accessing Level 2 HFR and Level 3 TNR/HFR (calibrated) data products. + + **HFR Level 2 Example:** - Examples - -------- >>> import sunpy_soar >>> from sunpy.net import Fido, attrs as a >>> from radiospectra.spectrogram import Spectrogram @@ -22,6 +24,34 @@ class RPWSpectrogram(GenericSpectrogram): [, ] >>> spec[0] .plot() #doctest: +SKIP + + **TNR Level 3 Example:** + + >>> import sunpy_soar #doctest: +REMOTE_DATA + >>> from sunpy.net import Fido, attrs as a #doctest: +REMOTE_DATA + >>> from radiospectra.spectrogram import Spectrogram #doctest: +REMOTE_DATA + >>> query = Fido.search(a.Time('2024/03/23 00:00', '2024/03/23 23:59'), #doctest: +REMOTE_DATA + ... a.Instrument.rpw, a.Level(3), a.Provider.soar) #doctest: +REMOTE_DATA + >>> downloaded = Fido.fetch(query[0][query[0]["Data product"]=='rpw-tnr-surv-flux'][0]) #doctest: +REMOTE_DATA + >>> spec = Spectrogram(downloaded[0]) #doctest: +REMOTE_DATA + >>> spec #doctest: +REMOTE_DATA + + >>> spec.plot() #doctest: +REMOTE_DATA + + + **HFR Level 3 Example:** + + >>> import sunpy_soar #doctest: +REMOTE_DATA + >>> from sunpy.net import Fido, attrs as a #doctest: +REMOTE_DATA + >>> from radiospectra.spectrogram import Spectrogram #doctest: +REMOTE_DATA + >>> query = Fido.search(a.Time('2024/03/23 00:00', '2024/03/23 23:59'), #doctest: +REMOTE_DATA + ... a.Instrument.rpw, a.Level(3), a.Provider.soar) #doctest: +REMOTE_DATA + >>> downloaded = Fido.fetch(query[0][query[0]["Data product"]=='rpw-hfr-surv-flux'][0]) #doctest: +REMOTE_DATA + >>> spec = Spectrogram(downloaded[0]) #doctest: +REMOTE_DATA + >>> spec #doctest: +REMOTE_DATA + + >>> spec.plot() #doctest: +REMOTE_DATA + """ @classmethod