Add CHAMP MAG data (#111)

* Adding support for CHAMP ME 3 MAG * Add CHAMP to documentation * Adapting CHAMP MAG configuration to the latest GFZ format. * Version bump to 0.12.0 --------- Co-authored-by: Martin Paces <[email protected]>
ESA-VirES · May 31, 2024 · 0ecec13 · 0ecec13
1 parent 95cb999
commit 0ecec13
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/docs/available_parameters.rst b/docs/available_parameters.rst
@@ -149,6 +149,7 @@ Calibrated magnetic data are also available from external missions: Cryosat-2, G
 =============================== ================ ===================================================================================================================================
 Collection full name            Collection type  Available measurement names
 =============================== ================ ===================================================================================================================================
+CH_ME_MAG_LR_3                  MAG_CHAMP        ``F,B_VFM,B_NEC,Flags_Position,Flags_B,Flags_q,Mode_q,q_ICRF_CRF``
 CS_OPER_MAG                     MAG_CS           ``F,B_NEC,B_mod_NEC,B_NEC1,B_NEC2,B_NEC3,B_FGM1,B_FGM2,B_FGM3,q_NEC_CRF,q_error``
 GRACE_x_MAG (x=A/B)             MAG_GRACE        ``F,B_NEC,B_NEC_raw,B_FGM,B_mod_NEC,q_NEC_CRF,q_error``
 GFx_OPER_FGM_ACAL_CORR (x=1/2)  MAG_GFO          ``F,B_NEC,B_FGM,dB_MTQ_FGM,dB_XI_FGM,dB_NY_FGM,dB_BT_FGM,dB_ST_FGM,dB_SA_FGM,dB_BAT_FGM,q_NEC_FGM,B_FLAG``

diff --git a/docs/release_notes.rst b/docs/release_notes.rst
@@ -4,7 +4,7 @@ Release notes
 Change log
 ----------
 
-Changes from 0.11.6 to 0.11.7
+Changes from 0.11.6 to 0.12.0
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 - Added auxiliaries ``["F107_avg81d", "F107_avg81d_count"]``
@@ -14,6 +14,8 @@ Changes from 0.11.6 to 0.11.7
   - e.g. ``"CH_OPER_DNS_ACC_2_"`` and ``"CH_OPER_WND_ACC_2_"`` from CHAMP and equivalents from GRACE and GRACE-FO
   - conjunction information within ``"MM_CON_SPH_2_:crossover"`` and ``"MM_CON_SPH_2_:plane_alignment"``
 
+- Added CHAMP magnetic dataset, ``CH_ME_MAG_LR_3``
+
 Changes from 0.11.5 to 0.11.6
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/src/viresclient/__init__.py b/src/viresclient/__init__.py
@@ -35,4 +35,4 @@
 from ._config import ClientConfig, set_token
 from ._data_handling import ReturnedData, ReturnedDataFile
 
-__version__ = "0.11.7"
+__version__ = "0.12.0-alpha"
diff --git a/src/viresclient/_client_swarm.py b/src/viresclient/_client_swarm.py
@@ -215,6 +215,7 @@
     "PPI_FAC": (
         "https://earth.esa.int/eogateway/activities/plasmapause-related-boundaries-in-the-topside-ionosphere-as-derived-from-swarm-measurements",
     ),
+    "MAG_CHAMP": ("https://doi.org/10.5880/GFZ.2.3.2019.004",),
     "MAG_CS": ("https://doi.org/10.1186/s40623-020-01171-9",),
     "MAG_GRACE": ("https://doi.org/10.1186/s40623-021-01373-9",),
     "MAG_GFO": ("https://doi.org/10.1186/s40623-021-01364-w",),
@@ -641,6 +642,7 @@ class SwarmRequest(ClientRequest):
         "PPI_FAC": [f"SW_OPER_PPI{x}FAC_2F" for x in "ABC"],
         "PPI_FAC:ID": [f"SW_OPER_PPI{x}FAC_2F:ID" for x in "ABC"],
         # Multi-mission magnetic products
+        "MAG_CHAMP": ["CH_ME_MAG_LR_3"],
         "MAG_CS": ["CS_OPER_MAG"],
         "MAG_GRACE": ["GRACE_A_MAG", "GRACE_B_MAG"],
         "MAG_GFO": ["GF1_OPER_FGM_ACAL_CORR", "GF2_OPER_FGM_ACAL_CORR"],
@@ -1098,6 +1100,16 @@ class SwarmRequest(ClientRequest):
             "Position_Quality",
             "PointType",
         ],
+        "MAG_CHAMP": [
+            "F",
+            "B_VFM",
+            "B_NEC",
+            "Flags_Position",
+            "Flags_B",
+            "Flags_q",
+            "Mode_q",
+            "q_ICRF_CRF",
+        ],
         "MAG_CS": [
             "F",
             "B_NEC",