From f15fa07e204bfc27e86c50026b106cc2641f7fa2 Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Fri, 3 May 2024 16:19:03 +0100 Subject: [PATCH] New MAG ML datasets (#108) * Adding GRACE-FO MAG ML dataset * GOCE MAG ML configuration adapted to the new 0301 baseline - removing KP_DST_FLAG - adding MAGNETIC_ACTIVITY_FLAG * Fixing missing comma. * GRACE_FO_ML: B_FGM corrected to B_MAG There was an error in the original files, later corrected by GFZ. * Update documentation --------- Co-authored-by: Martin Paces --- docs/available_parameters.rst | 5 +++-- docs/release_notes.rst | 11 +++++++++++ src/viresclient/__init__.py | 2 +- src/viresclient/_client_swarm.py | 14 +++++++++++++- 4 files changed, 28 insertions(+), 4 deletions(-) diff --git a/docs/available_parameters.rst b/docs/available_parameters.rst index f6f699b..18eaf4c 100644 --- a/docs/available_parameters.rst +++ b/docs/available_parameters.rst @@ -137,8 +137,9 @@ Collection full name Collection type Available measurement names 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`` +GFx_MAG_ACAL_CORR_ML (x=1/2) MAG_GFO_ML ``F,B_MAG,B_NEC,q_NEC_FGM,B_FLAG,KP_DST_FLAG,Latitude_QD,Longitude_QD`` GO_MAG_ACAL_CORR MAG_GOCE ``F,B_MAG,B_NEC,dB_MTQ_SC,dB_XI_SC,dB_NY_SC,dB_BT_SC,dB_ST_SC,dB_SA_SC,dB_BAT_SC,dB_HK_SC,dB_BLOCK_CORR,q_SC_NEC,q_MAG_SC,B_FLAG`` -GO_MAG_ACAL_CORR_ML MAG_GOCE_ML ``B_MAG,B_NEC,q_FGM_NEC,B_FLAG,KP_DST_FLAG,NaN_FLAG,Latitude_QD,Longitude_QD`` +GO_MAG_ACAL_CORR_ML MAG_GOCE_ML ``F,B_MAG,B_NEC,q_FGM_NEC,B_FLAG,MAGNETIC_ACTIVITY_FLAG,NaN_FLAG,Latitude_QD,Longitude_QD`` =============================== ================ =================================================================================================================================== The ``measurements``, ``models``, and ``auxiliaries`` chosen will match the cadence of the ``collection`` chosen. @@ -302,7 +303,7 @@ NB: When using model names containing a hyphen (``-``) then extra single (``'``) AscendingNodeLongitude, QDLat, QDLon, QDBasis, MLT, SunDeclination, SunHourAngle, SunRightAscension, SunAzimuthAngle, SunZenithAngle, SunLongitude, SunVector, DipoleAxisVector, NGPLatitude, NGPLongitude, - DipoleTiltAngle + DipoleTiltAngle, F107_avg81d, F107_avg81d_count .. note:: diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 04f763f..7281217 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -4,6 +4,17 @@ Release notes Change log ---------- +Changes from 0.11.6 to 0.11.7 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +- Added auxiliaries ``["F107_avg81d", "F107_avg81d_count"]`` +- Updated and added ML-calibrated variants of GOCE & GRACE-FO magnetic datasets, ``GO_MAG_ACAL_CORR_ML`` & ``GFx_MAG_ACAL_CORR_ML`` + +Changes from 0.11.5 to 0.11.6 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +- Fix to allow multiple VOBS to be fetched in one request + Changes from 0.11.4 to 0.11.5 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/src/viresclient/__init__.py b/src/viresclient/__init__.py index 0ce4b88..1a86f0d 100644 --- 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.6" +__version__ = "0.11.7" diff --git a/src/viresclient/_client_swarm.py b/src/viresclient/_client_swarm.py index cf2c011..eb77fbb 100644 --- a/src/viresclient/_client_swarm.py +++ b/src/viresclient/_client_swarm.py @@ -218,6 +218,7 @@ "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",), + "MAG_GFO_ML": ("https://doi.org/10.5880/GFZ.2.3.2023.001",), "EFI_IDM": ( "https://earth.esa.int/eogateway/documents/20142/2860886/SLIDEM_Product_Definition.pdf", ), @@ -626,6 +627,7 @@ class SwarmRequest(ClientRequest): "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"], + "MAG_GFO_ML": ["GF1_MAG_ACAL_CORR_ML", "GF2_MAG_ACAL_CORR_ML"], "MAG_GOCE": ["GO_MAG_ACAL_CORR"], "MAG_GOCE_ML": ["GO_MAG_ACAL_CORR_ML"], # Swarm spacecraft positions @@ -1091,6 +1093,16 @@ class SwarmRequest(ClientRequest): "q_NEC_FGM", "B_FLAG", ], + "MAG_GFO_ML": [ + "F", + "B_MAG", + "B_NEC", + "q_NEC_FGM", + "B_FLAG", + "KP_DST_FLAG", + "Latitude_QD", + "Longitude_QD", + ], "MAG_GOCE": [ "F", "B_MAG", @@ -1114,7 +1126,7 @@ class SwarmRequest(ClientRequest): "B_NEC", "q_FGM_NEC", "B_FLAG", - "KP_DST_FLAG", + "MAGNETIC_ACTIVITY_FLAG", "NaN_FLAG", "Latitude_QD", "Longitude_QD",