Skip to content

Commit 3fd09cc

Browse files
author
Herman le Roux
committed
Updates SOLO RPW examples
Updates link to instrument information. Adds docstring examples for level 3 HFR and TNR data products. Reformats level 2 HFR example. Add changelog entry.
1 parent 346d9a3 commit 3fd09cc

2 files changed

Lines changed: 35 additions & 4 deletions

File tree

changelog/173.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Created docstring examples for ``RPWSpectrogram`` data.

radiospectra/spectrogram/sources/rpw.py

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@
55

66
class RPWSpectrogram(GenericSpectrogram):
77
"""
8-
Solar Orbiter Radio and Plasma Waves (RPW) RPW-HFR-SURV spectrogram.
8+
Solar Orbiter Radio and Plasma Waves (RPW) spectrogram.
99
10-
For more information on the instrument see `<https://rpw.lesia.obspm.fr>`__.
10+
For more information on the instrument see `<https://rpw-datacenter.obspm.fr>`__.
11+
12+
Examples for accessing Level 2 HFR and Level 3 TNR/HFR (calibrated) data products.
13+
14+
**HFR Level 2 Example:**
1115
12-
Examples
13-
--------
1416
>>> import sunpy_soar
1517
>>> from sunpy.net import Fido, attrs as a
1618
>>> from radiospectra.spectrogram import Spectrogram
@@ -22,6 +24,34 @@ class RPWSpectrogram(GenericSpectrogram):
2224
[<RPWSpectrogram SOLO, RPW, RPW-AGC1 375.0 kHz - 16375.0 kHz, 2020-07-11T00:00:39.352 to 2020-07-12T00:00:55.715>, <RPWSpectrogram SOLO, RPW, RPW-AGC2 375.0 kHz - 16375.0 kHz, 2020-07-11T00:00:39.352 to 2020-07-12T00:00:55.715>]
2325
>>> spec[0] .plot() #doctest: +SKIP
2426
<matplotlib.collections.QuadMesh object at ...>
27+
28+
**TNR Level 3 Example:**
29+
30+
>>> import sunpy_soar #doctest: +REMOTE_DATA
31+
>>> from sunpy.net import Fido, attrs as a #doctest: +REMOTE_DATA
32+
>>> from radiospectra.spectrogram import Spectrogram #doctest: +REMOTE_DATA
33+
>>> query = Fido.search(a.Time('2024/03/23 00:00', '2024/03/23 23:59'), #doctest: +REMOTE_DATA
34+
... a.Instrument.rpw, a.Level(3), a.Provider.soar) #doctest: +REMOTE_DATA
35+
>>> downloaded = Fido.fetch(query[0][query[0]["Data product"]=='rpw-tnr-surv-flux'][0]) #doctest: +REMOTE_DATA
36+
>>> spec = Spectrogram(downloaded[0]) #doctest: +REMOTE_DATA
37+
>>> spec #doctest: +REMOTE_DATA
38+
<RPWSpectrogram SOLO, RPW, RPW-TNR 3.992000102996826 kHz - 978.572021484375 kHz, 2024-03-23T00:04:32.873 to 2024-03-24T00:04:46.381>
39+
>>> spec.plot() #doctest: +REMOTE_DATA
40+
<matplotlib.collections.QuadMesh object at ...>
41+
42+
**HFR Level 3 Example:**
43+
44+
>>> import sunpy_soar #doctest: +REMOTE_DATA
45+
>>> from sunpy.net import Fido, attrs as a #doctest: +REMOTE_DATA
46+
>>> from radiospectra.spectrogram import Spectrogram #doctest: +REMOTE_DATA
47+
>>> query = Fido.search(a.Time('2024/03/23 00:00', '2024/03/23 23:59'), #doctest: +REMOTE_DATA
48+
... a.Instrument.rpw, a.Level(3), a.Provider.soar) #doctest: +REMOTE_DATA
49+
>>> downloaded = Fido.fetch(query[0][query[0]["Data product"]=='rpw-hfr-surv-flux'][0]) #doctest: +REMOTE_DATA
50+
>>> spec = Spectrogram(downloaded[0]) #doctest: +REMOTE_DATA
51+
>>> spec #doctest: +REMOTE_DATA
52+
<RPWSpectrogram SOLO, RPW, RPW-HFR 425.0000305175781 kHz - 16325.0009765625 kHz, 2024-03-23T00:04:14.063 to 2024-03-24T00:04:07.571>
53+
>>> spec.plot() #doctest: +REMOTE_DATA
54+
<matplotlib.collections.QuadMesh object at ...>
2555
"""
2656

2757
@classmethod

0 commit comments

Comments
 (0)