PRISM products (#64)

* Temporary workaround allowing loading of the MITx_LP, MITxTEC and PPIxFAC Quality * Add config for MITx & PPI * Remove AOB_Quality xarray dimension * Add PRISM products to docs Co-authored-by: Martin Paces <martin.paces@eox.at>
ESA-VirES · Aug 23, 2021 · 35aa9d6 · 35aa9d6
1 parent 70e6583
commit 35aa9d6
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 5 deletions.
diff --git a/docs/available_parameters.rst b/docs/available_parameters.rst
@@ -63,6 +63,19 @@ SW_OPER_AEJxPBS_2F:GroundMagneticDisturbance AEJ_PBS:GroundMagneticDisturbance -
 SW_OPER_AOBxFAC_2F                           AOB_FAC                           Auroral oval boundaries derived from FACs
 ============================================ ================================= ==============================================================
 
+The PRISM (Plasmapause Related boundaries in the topside Ionosphere as derived from Swarm Measurements) products are provided as:
+
+====================== ================ ===================================================================================================
+Collection full name   Collection type  Description
+====================== ================ ===================================================================================================
+SW_OPER_MITx_LP_2F     MIT_LP           Minima of the Midlatitude Ionospheric Trough (MIT) - derived from Langmuir Probe (LP) measurements
+SW_OPER_MITx_LP_2F:ID  MIT_LP:ID        -> Boundaries of the MIT - derived from the LP
+SW_OPER_MITxTEC_2F     MIT_TEC          Minima of the MIT - derived from Total Electron Content (TEC)
+SW_OPER_MITxTEC_2F:ID  MIT_TEC:ID       -> Boundaries of the MIT - derived from TEC
+SW_OPER_PPIxFAC_2F     PPI_FAC          Midnight Plasmapause Index (PPI) 
+SW_OPER_PPIxFAC_2F:ID  PPI_FAC:ID       -> Boundaries of the Small-Scale Field Aligned Currents (SSFAC)
+====================== ================ ===================================================================================================
+
 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.
 
 ======================== ================ ==============================================================
@@ -129,6 +142,19 @@ AEJ_PBS:GroundMagneticDisturbance ``B_NE``
 AOB_FAC                           ``Latitude_QD,Longitude_QD,MLT_QD,Boundary_Flag,Quality,Pair_Indicator``
 ================================= ================================================================================
 
+PRISM products:
+
+================ ================================================================================================================
+Collection type  Available measurement names
+================ ================================================================================================================
+MIT_LP           ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,Ne,Te,Depth,DR,Width,dL,PW_Gradient,EW_Gradient,Quality``
+MIT_LP:ID        ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,Ne,Te,Position_Quality,PointType``
+MIT_TEC          ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,TEC,Depth,DR,Width,dL,PW_Gradient,EW_Gradient,Quality``
+MIT_TEC:ID       ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,TEC,Position_Quality,PointType``
+PPI_FAC          ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,Sigma,PPI,dL,Quality``
+PPI_FAC:ID       ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,Position_Quality,PointType``
+================ ================================================================================================================
+
 AUX_OBS products:
 
 =============== =========================================

diff --git a/docs/release_notes.rst b/docs/release_notes.rst
@@ -4,9 +4,13 @@ Release notes
 Change log
 ----------
 
-Changes from 0.8.0 to 0.8.1
+Changes from 0.8.0 to 0.9.0
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+- Added support for:
+
+  - PRISM products (``SW_OPER_MITx_LP_2F``, ``SW_OPER_MITxTEC_2F``, ``SW_OPER_PPIxFAC_2F``)
+
 - Fixed missing auxiliary "dDst"
 - Fixed fetching longer time series of hourly observatory products
 - Added new progress bar that tracks processing of chunks in long requests

diff --git a/viresclient/__init__.py b/viresclient/__init__.py
@@ -37,4 +37,4 @@
 from . import _data
 
 
-__version__ = "0.8.1-alpha1"
+__version__ = "0.9.0-alpha1"
diff --git a/viresclient/_client_swarm.py b/viresclient/_client_swarm.py
@@ -482,6 +482,12 @@ class SwarmRequest(ClientRequest):
             "CO_OPER_VOBS_4M_2_:SecularVariation",
             *[f"CO_OPER_VOBS_4M_2_:SecularVariation:{site}" for site in VOBS_SITES]
         ],
+        "MIT_LP": [f"SW_OPER_MIT{x}_LP_2F" for x in "ABC"],
+        "MIT_LP:ID": [f"SW_OPER_MIT{x}_LP_2F:ID" for x in "ABC"],
+        "MIT_TEC": [f"SW_OPER_MIT{x}TEC_2F" for x in "ABC"],
+        "MIT_TEC:ID": [f"SW_OPER_MIT{x}TEC_2F:ID" for x in "ABC"],
+        "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"],
     }
 
     OBS_COLLECTIONS = [
@@ -534,6 +540,12 @@ class SwarmRequest(ClientRequest):
         "VOBS_CH_4M:SecularVariation": "P122D",
         "VOBS_CR_4M:SecularVariation": "P122D",
         "VOBS_CO_4M:SecularVariation": "P122D",
+        "MIT_LP": "PT20M",
+        "MIT_LP:ID": "PT20M",
+        "MIT_TEC": "PT20M",
+        "MIT_TEC:ID": "PT20M",
+        "PPI_FAC": "PT20M",
+        "PPI_FAC:ID": "PT20M",
     }
 
     PRODUCT_VARIABLES = {
@@ -612,6 +624,32 @@ class SwarmRequest(ClientRequest):
         "VOBS_CH_4M:SecularVariation": ["SiteCode", "B_SV", "sigma_SV"],
         "VOBS_CR_4M:SecularVariation": ["SiteCode", "B_SV", "sigma_SV"],
         "VOBS_CO_4M:SecularVariation": ["SiteCode", "B_SV", "sigma_SV"],
+        "MIT_LP": [
+            "Counter", "Latitude_QD", "Longitude_QD", "MLT_QD", "L_value", "SZA",
+            "Ne", "Te", "Depth", "DR", "Width", "dL", "PW_Gradient", "EW_Gradient",
+            "Quality",
+        ],
+        "MIT_LP:ID": [
+            "Counter", "Latitude_QD", "Longitude_QD", "MLT_QD", "L_value", "SZA",
+            "Ne", "Te", "Position_Quality", "PointType",
+        ],
+        "MIT_TEC": [
+            "Counter", "Latitude_QD", "Longitude_QD", "MLT_QD", "L_value", "SZA",
+            "TEC", "Depth", "DR", "Width", "dL", "PW_Gradient", "EW_Gradient",
+            "Quality",
+        ],
+        "MIT_TEC:ID": [
+            "Counter", "Latitude_QD", "Longitude_QD", "MLT_QD", "L_value", "SZA",
+            "TEC", "Position_Quality", "PointType",
+        ],
+        "PPI_FAC": [
+            "Counter", "Latitude_QD", "Longitude_QD", "MLT_QD", "L_value", "SZA",
+            "Sigma", "PPI", "dL", "Quality",
+        ],
+        "PPI_FAC:ID": [
+            "Counter", "Latitude_QD", "Longitude_QD", "MLT_QD", "L_value", "SZA",
+            "Position_Quality", "PointType",
+        ],
     }
 
     AUXILIARY_VARIABLES = [

diff --git a/viresclient/_data_handling.py b/viresclient/_data_handling.py
@@ -50,7 +50,6 @@
     "WGS84": ["GPS_Position", "LEO_Position"],
     "EEJ_QDLat": ["EEJ"],
     "NE": ["J_NE", "J_CF_NE", "J_DF_NE", "B_NE"],
-    "AOB_Quality": ["Quality"],
 }
 # Reverse mapping of the above
 DATANAMES_TO_FRAME_NAMES = {}
@@ -66,14 +65,12 @@
     "WGS84": ["X", "Y", "Z"],
     "EEJ_QDLat": numpy.linspace(-20, 20, 81),
     "NE": ["N", "E"],
-    "AOB_Quality": ["Pa", "Sigma"],
 }
 FRAME_DESCRIPTIONS = {
     "NEC": "NEC frame - North, East, Centre (down)",
     "NE": "Horizontal NE frame - North, East",
     "VFM": "Vector Field Magnetometer instrument frame",
     "EEJ_QDLat": "Quasi-dipole latitude profile between -20 and 20 degrees from the EEF product",
-    "AEJ_Quality": "Boundary quality indicator (Pa, Sigma)",
 }