Skip to content

Commit 0ebf14f

Browse files
smitharapacesm
smithara
and
pacesm
authored
Add ULF and PC1 wave products (#124)
* Adding support for ULFxMAG_2F and PC1xMAG_2F products. --------- Co-authored-by: Martin Paces <[email protected]>
1 parent 11e2c44 commit 0ebf14f

File tree

2 files changed

+154
-1
lines changed

2 files changed

+154
-1
lines changed

‎docs/available_parameters.rst

+16
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,22 @@ MM_CON_SPH_2\_:crossover Conjunction information (times w
113113
MM_CON_SPH_2\_:plane_alignment Conjunction information (times when orbital planes align)
114114
============================== ================ ===================================================================================================
115115

116+
`ULF wave products <https://earth.esa.int/eogateway/activities/swarm-ulf-ionosphere>`_ are provided as:
117+
118+
================================= ===================
119+
Collection full name Collection type
120+
================================= ===================
121+
SW_OPER_ULFxMAG_2F ULF_MAG
122+
SW_OPER_ULFxMAG_2F:event ULF_MAG:event
123+
SW_OPER_ULFxMAG_2F:event_mean ULF_MAG:event_mean
124+
SW_OPER_PC1xMAG_2F:Bp_event PC1_MAG:event
125+
SW_OPER_PC1xMAG_2F:Br_event PC1_MAG:event
126+
SW_OPER_PC1xMAG_2F:Ba_event PC1_MAG:event
127+
SW_OPER_PC1xMAG_2F:Bp_event_mean PC1_MAG:event_mean
128+
SW_OPER_PC1xMAG_2F:Br_event_mean PC1_MAG:event_mean
129+
SW_OPER_PC1xMAG_2F:Ba_event_mean PC1_MAG:event_mean
130+
================================= ===================
131+
116132
The AUX_OBS collections contain ground magnetic observatory data from `INTERMAGNET <https://intermagnet.github.io/data_conditions.html>`_ and `WDC <http://www.wdc.bgs.ac.uk/>`_. Please note that these data are provided under different usage terms than the ESA data, and must be acknowledged accordingly.
117133

118134
======================== ================ ==============================================================

‎src/viresclient/_client_swarm.py

+138-1
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,8 @@
216216
"WND_ACC_GRACE": ("https://swarmhandbook.earth.esa.int/catalogue/GR_WNDxACC_2_",),
217217
"WND_ACC_GFO": ("https://swarmhandbook.earth.esa.int/catalogue/GF_WNDxACC_2_",),
218218
"MM_CON_EPH_2_": ("https://swarmhandbook.earth.esa.int/catalogue/MM_CON_EPH_2_",),
219+
"ULF_MAG": ("https://swarmhandbook.earth.esa.int/catalogue/SW_ULFxMAG_2F",),
220+
"PC1_MAG": ("https://swarmhandbook.earth.esa.int/catalogue/SW_PC1xMAG_2F",),
219221
}
220222
for mission in ("SW", "OR", "CH", "CR", "CO"):
221223
for cadence in ("1M", "4M"):
@@ -646,6 +648,24 @@ class SwarmRequest(ClientRequest):
646648
# TOLEOS conjunctions
647649
"MM_CON_EPH_2_:crossover": ["MM_OPER_CON_EPH_2_:crossover"],
648650
"MM_CON_EPH_2_:plane_alignment": ["MM_OPER_CON_EPH_2_:plane_alignment"],
651+
# ULF and PC1 products
652+
"ULF_MAG": [f"SW_OPER_ULF{spacecraft}MAG_2F" for spacecraft in "ABC"],
653+
"ULF_MAG:event": [
654+
f"SW_OPER_ULF{spacecraft}MAG_2F:event" for spacecraft in "ABC"
655+
],
656+
"ULF_MAG:event_mean": [
657+
f"SW_OPER_ULF{spacecraft}MAG_2F:event_mean" for spacecraft in "ABC"
658+
],
659+
"PC1_MAG:event": [
660+
*(f"SW_OPER_PC1{spacecraft}MAG_2F:Bp_event" for spacecraft in "ABC"),
661+
*(f"SW_OPER_PC1{spacecraft}MAG_2F:Br_event" for spacecraft in "ABC"),
662+
*(f"SW_OPER_PC1{spacecraft}MAG_2F:Ba_event" for spacecraft in "ABC"),
663+
],
664+
"PC1_MAG:event_mean": [
665+
*(f"SW_OPER_PC1{spacecraft}MAG_2F:Bp_event_mean" for spacecraft in "ABC"),
666+
*(f"SW_OPER_PC1{spacecraft}MAG_2F:Br_event_mean" for spacecraft in "ABC"),
667+
*(f"SW_OPER_PC1{spacecraft}MAG_2F:Ba_event_mean" for spacecraft in "ABC"),
668+
],
649669
}
650670

651671
OBS_COLLECTIONS = [
@@ -675,7 +695,9 @@ class SwarmRequest(ClientRequest):
675695
]
676696

677697
# These are not necessarily real sampling steps, but are good enough to use
678-
# for splitting long requests into chunks
698+
# for splitting long requests into chunks.
699+
# The time step set here should be equal to or shorter than the real sampling
700+
# (defaults to PT1S if not set)
679701
COLLECTION_SAMPLING_STEPS = {
680702
"MAG": "PT1S",
681703
"MAG_HR": "PT0.019S", # approx 50Hz (the sampling is not exactly 50Hz)
@@ -730,6 +752,11 @@ class SwarmRequest(ClientRequest):
730752
"WND_ACC_GFO": "PT10S",
731753
"MM_CON_EPH_2_:crossover": "PT20M",
732754
"MM_CON_EPH_2_:plane_alignment": "P1D",
755+
"ULF_MAG": "PT1M",
756+
"ULF_MAG:event": "PT1S", # irregular sampling
757+
"ULF_MAG:event_mean": "PT1M", # irregular sampling
758+
"PC1_MAG:event": "PT1S", # irregular sampling
759+
"PC1_MAG:event_mean": "PT1M", # irregular sampling
733760
}
734761

735762
PRODUCT_VARIABLES = {
@@ -1264,6 +1291,116 @@ class SwarmRequest(ClientRequest):
12641291
"satellite_1",
12651292
"satellite_2",
12661293
],
1294+
"ULF_MAG": [
1295+
"Timestamp",
1296+
"Latitude",
1297+
"Longitude",
1298+
"Radius",
1299+
"Latitude_QD",
1300+
"Longitude_QD",
1301+
"MLT_QD",
1302+
"UT",
1303+
"SZA",
1304+
"Frequency_dominant",
1305+
"Halfwidth",
1306+
"Power",
1307+
"Prominence",
1308+
"Pc2_act",
1309+
"Pc3_act",
1310+
"Pc4_act",
1311+
"Pi2_act",
1312+
"Flag_Pc2",
1313+
"Flag_Pc3",
1314+
"Flag_Pc4",
1315+
"Flag_Pi2",
1316+
"Flag_EPB",
1317+
"Flag_FAC",
1318+
],
1319+
"ULF_MAG:event": [
1320+
"Timestamp",
1321+
"Latitude",
1322+
"Longitude",
1323+
"Radius",
1324+
"Latitude_QD",
1325+
"Longitude_QD",
1326+
"MLT_QD",
1327+
"SZA",
1328+
"ID",
1329+
"ORB",
1330+
"DIR",
1331+
"Frequency",
1332+
"Halfwidth",
1333+
"Power",
1334+
"Prominence",
1335+
"EPB",
1336+
"FAC",
1337+
"Flag_B",
1338+
"Quality",
1339+
],
1340+
"ULF_MAG:event_mean": [
1341+
"Timestamp",
1342+
"Latitude",
1343+
"Longitude",
1344+
"Radius",
1345+
"Latitude_QD",
1346+
"Longitude_QD",
1347+
"MLT_QD",
1348+
"SZA",
1349+
"ID",
1350+
"ORB",
1351+
"DIR",
1352+
"Duration",
1353+
"Frequency",
1354+
"Freq_std",
1355+
"Halfwidth",
1356+
"Power",
1357+
"Prominence",
1358+
"EPB",
1359+
"FAC",
1360+
"Flag_B",
1361+
"Quality",
1362+
],
1363+
"PC1_MAG:event": [
1364+
"ID",
1365+
"Timestamp",
1366+
"Latitude",
1367+
"Longitude",
1368+
"Radius",
1369+
"Latitude_QD",
1370+
"Longitude_QD",
1371+
"MLT_QD",
1372+
"SZA",
1373+
"ORB",
1374+
"DIR",
1375+
"Frequency",
1376+
"Halfwidth",
1377+
"Power",
1378+
"Prominence",
1379+
"Quality_B",
1380+
"Quality_p",
1381+
"Quality_n",
1382+
],
1383+
"PC1_MAG:event_mean": [
1384+
"Timestamp",
1385+
"Latitude",
1386+
"Longitude",
1387+
"Radius",
1388+
"Latitude_QD",
1389+
"Longitude_QD",
1390+
"MLT_QD",
1391+
"SZA",
1392+
"ID",
1393+
"ORB",
1394+
"DIR",
1395+
"Duration",
1396+
"Frequency",
1397+
"Freq_std",
1398+
"Halfwidth",
1399+
"Power",
1400+
"Prominence",
1401+
"ROFC",
1402+
"Quality",
1403+
],
12671404
}
12681405

12691406
AUXILIARY_VARIABLES = [

0 commit comments

Comments
 (0)