Merge pull request #88 from ESA-VirES/staging

Merge staging to master: v0.11.0 release for VirES for Swarm v3.10.0

Author: smithara

README.rst

@@ -6,10 +6,6 @@
     :target: http://viresclient.readthedocs.io/
     :alt: Documentation Status
 
-.. image:: https://requires.io/github/ESA-VirES/VirES-Python-Client/requirements.svg?branch=master
-    :target: https://requires.io/github/ESA-VirES/VirES-Python-Client/requirements/?branch=master
-    :alt: Requirements Status
-
 .. image:: https://zenodo.org/badge/138034133.svg
    :target: https://zenodo.org/badge/latestdoi/138034133
 

docs/api.rst

@@ -9,7 +9,7 @@ SwarmRequest
     :undoc-members:
     :show-inheritance:
     :inherited-members:
-    :exclude-members: AUXILIARY_VARIABLES, COLLECTIONS, COLLECTION_SAMPLING_STEPS, MAGNETIC_MODELS, MAGNETIC_MODEL_VARIABLES, OBS_COLLECTIONS, PRODUCT_VARIABLES
+    :exclude-members: AUXILIARY_VARIABLES, COLLECTIONS, COLLECTION_SAMPLING_STEPS, MAGNETIC_MODELS, MAGNETIC_MODEL_VARIABLES, OBS_COLLECTIONS, PRODUCT_VARIABLES, CONJUNCTION_MISSION_SPACECRAFT_PAIRS, MISSION_SPACECRAFTS
 
 AeolusRequest
 -------------

docs/available_parameters.rst

@@ -1,6 +1,10 @@
 Available parameters for Swarm
 ==============================
 
+.. tip::
+
+  Did you know? The *VirES for Swarm* service provides data not only from Swarm but also INTERMAGNET ground observatories (search below for ``AUX_OBS``), and recalibrated platform magnetometer data from selected LEO missions (search below for ``MAG_``).
+
 .. note::
 
   | `See also: Jupyter notebook about data and model availability <https://notebooks.vires.services/notebooks/02b__viresclient-available-data>`_ - check out the other demo notebooks there too.
@@ -43,6 +47,7 @@ SW_OPER_EFIx_LP_1B       EFI              Electric field instrument (Langmuir pr
 SW_OPER_EFIxTIE_2\_       EFI_TIE          Estimates of the ion temperatures
 SW_EXPT_EFIx_TCT02       EFI_TCT02        2Hz cross-track ion flows
 SW_EXPT_EFIx_TCT16       EFI_TCT16        16Hz cross-track ion flows
+SW_PREL_EFIxIDM_2\_      EFI_IDM          2Hz ion drift velocities and effective masses (SLIDEM project)
 SW_OPER_IPDxIRR_2F       IPD              Ionospheric plasma characteristics (derived quantities at 1Hz)
 SW_OPER_TECxTMS_2F       TEC              Total electron content
 SW_OPER_FACxTMS_2F       FAC              Field-aligned currents (single satellite)
@@ -113,15 +118,16 @@ SW_OPER_VOBS_1M_2\_:SecularVariation VOBS_SW_1M:SecularVariation Secular variati
 
 Each VOBS product (e.g. Swarm 1-monthly) is split into two collections (e.g. ``SW_OPER_VOBS_1M_2_`` (containing ``B_OB`` & ``B_CF``) and ``SW_OPER_VOBS_1M_2_:SecularVariation`` (containing ``B_SV``)) because of the different temporal sampling points (i.e. differing ``Timestamp``) of these measurements. Data can also be requested for a specific virtual observatory alone (distinguishable by the ``SiteCode`` variable) with special collection names like ``SW_OPER_VOBS_1M_2_:N65W051`` and ``SW_OPER_VOBS_1M_2_:SecularVariation:N65W051``.
 
-Calibrated magnetic data are also available from external missions: Cryosat-2, GRACE (A+B), GRACE-FO (1+2):
+Calibrated magnetic data are also available from external missions: Cryosat-2, GRACE (A+B), GRACE-FO (1+2), GOCE:
 
-=============================== ================ =========================================================================================================
+=============================== ================ ===================================================================================================================================
 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          ``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_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``
+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``
+=============================== ================ ===================================================================================================================================
 
 The ``measurements``, ``models``, and ``auxiliaries`` chosen will match the cadence of the ``collection`` chosen.
 
@@ -140,6 +146,7 @@ MAG_HR          ``F,B_VFM,B_NEC,dB_Sun,dB_AOCS,dB_other,B_error,q_NEC_CRF,Att_er
 EFI             ``U_orbit,Ne,Ne_error,Te,Te_error,Vs,Vs_error,Flags_LP,Flags_Ne,Flags_Te,Flags_Vs``
 EFI_TIE         ``Latitude_GD,Longitude_GD,Height_GD,Radius_GC,Latitude_QD,MLT_QD,Tn_msis,Te_adj_LP,Ti_meas_drift,Ti_model_drift,Flag_ti_meas,Flag_ti_model``
 EFI_TCTyy       ``VsatC,VsatE,VsatN,Bx,By,Bz,Ehx,Ehy,Ehz,Evx,Evy,Evz,Vicrx,Vicry,Vicrz,Vixv,Vixh,Viy,Viz,Vixv_error,Vixh_error,Viy_error,Viz_error,Latitude_QD,MLT_QD,Calibration_flags,Quality_flags``
+EFI_IDM         ``Latitude_GD,Longitude_GD,Height_GD,Radius_GC,Latitude_QD,MLT_QD,V_sat_nec,M_i_eff,M_i_eff_err,M_i_eff_Flags,M_i_eff_tbt_model,V_i,V_i_err,V_i_Flags,V_i_raw,N_i,N_i_err,N_i_Flags,A_fp,R_p,T_e,Phi_sc``
 IPD             ``Ne,Te,Background_Ne,Foreground_Ne,PCP_flag,Grad_Ne_at_100km,Grad_Ne_at_50km,Grad_Ne_at_20km,Grad_Ne_at_PCP_edge,ROD,RODI10s,RODI20s,delta_Ne10s,delta_Ne20s,delta_Ne40s,Num_GPS_satellites,mVTEC,mROT,mROTI10s,mROTI20s,IBI_flag,Ionosphere_region_flag,IPIR_index,Ne_quality_flag,TEC_STD``
 TEC             ``GPS_Position,LEO_Position,PRN,L1,L2,P1,P2,S1,S2,Elevation_Angle,Absolute_VTEC,Absolute_STEC,Relative_STEC,Relative_STEC_RMS,DCB,DCB_Error``
 FAC             ``IRC,IRC_Error,FAC,FAC_Error,Flags,Flags_F,Flags_B,Flags_q``

docs/capabilities.rst

@@ -0,0 +1,48 @@
+VirES capabilities
+==================
+
+VirES provides more than just *access* to data. Some operations can be peformed on the data in-situ on the server side before being delivered to you.
+
+.. tabs::
+
+  .. group-tab:: Swarm
+
+    **Data subsetting/filtering**
+      | Select data satisfying given conditions (e.g. searching a geographical range; selecting by quality flags)
+      | :py:meth:`viresclient.SwarmRequest.set_range_filter`
+      | :py:meth:`viresclient.SwarmRequest.set_choice_filter`
+      | :py:meth:`viresclient.SwarmRequest.set_bitmask_filter`
+      | :py:meth:`viresclient.SwarmRequest.add_filter` (for arbitrary filters)
+    **Data resampling**
+      | Time series can be resampled to a given cadence
+      | See `sampling_step` option in :py:meth:`viresclient.SwarmRequest.set_products`
+    **Querying information about data**
+      | *For example:*
+      | :py:meth:`viresclient.SwarmRequest.available_times`
+      | :py:meth:`viresclient.SwarmRequest.get_orbit_number`
+      | :py:meth:`viresclient.SwarmRequest.get_times_for_orbits`
+    **Geomagnetic model evaluation**
+      | Forwards evaluation of magnetic field models when a magnetic dataset is selected (e.g. ``MAGx_LR``)
+      | :py:meth:`viresclient.SwarmRequest.available_models`
+      | :py:meth:`viresclient.SwarmRequest.get_model_info`
+      | `models` option in :py:meth:`viresclient.SwarmRequest.set_products`
+    **Identifying conjunctions between spacecraft**
+      | :py:meth:`viresclient.SwarmRequest.get_conjunctions`
+    **Synchronous and asynchronous processing**
+      When using :py:meth:`viresclient.SwarmRequest.get_between` with small requests, change the default of `asynchronous=True` to `asynchronous=False` to process faster (no progress bar). By default, jobs are processed asynchronously (i.e. entered into a queue) which is appropriate for longer requests. You can only have two asynchronous jobs running at one time.
+
+  .. group-tab:: Aeolus
+
+    **Data subsetting/filtering**
+      | Select data satisfying given conditions (e.g. searching a geographical range; selecting by quality flags)
+      | :py:meth:`viresclient.AeolusRequest.set_range_filter`
+      | :py:meth:`viresclient.AeolusRequest.set_bbox`
+    **Querying information about data**
+      | *For example:*
+      | :py:meth:`viresclient.AeolusRequest.available_times`
+    **Synchronous and asynchronous processing**
+      When using :py:meth:`viresclient.AeolusRequest.get_between` with small requests, change the default of `asynchronous=True` to `asynchronous=False` to process faster (no progress bar). By default, jobs are processed asynchronously (i.e. entered into a queue) which is appropriate for longer requests. You can only have two asynchronous jobs running at one time.
+
+**Uploading data**
+  | Data of certain formats can be uploaded to the server and then manipulated like existing datasets (available privately within your account)
+  | See :doc:`cli` and :py:meth:`viresclient.DataUpload`

docs/conf.py

@@ -36,8 +36,12 @@
     "sphinx.ext.autosectionlabel",
     "sphinx_copybutton",
     "sphinx.ext.viewcode",
+    "sphinx_tabs.tabs",
 ]
 
+# sphinx-tabs options
+sphinx_tabs_disable_tab_closing = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -55,7 +59,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/config_details.rst

@@ -22,7 +22,9 @@ Configuration Details
 
   ... then follow automatic instructions to configure token if not already set
 
-NB: URL's on this page assume using *VirES for Swarm*. If using *Aeolus* instead, replace ``https://vires.services/ows`` with ``https://aeolus.services/ows``.
+.. note::
+
+  URL's on this page assume using *VirES for Swarm*. If using *Aeolus* instead, replace {``https://vires.services/ows`` and ``SwarmRequest``} with {``https://aeolus.services/ows`` and ``AeolusRequest``}
 
 While it is possible to enter the server URL and access credentials (see :doc:`access_token`) each time a new request object is created,
 

docs/index.rst

@@ -4,6 +4,7 @@ Introduction
 .. include:: ../README.rst
 
 .. toctree::
+  :hidden:
   :caption: Virtual Research Environments
 
   VirES for Swarm <https://vires.services>
@@ -13,26 +14,30 @@ Introduction
 
 
 .. toctree::
+  :hidden:
   :maxdepth: 2
   :caption: Information on viresclient
 
   self
   installation
   config_details
   access_token
+  capabilities
   available_parameters
   available_parameters_aeolus
   notebook_intro
   release_notes
 
 .. toctree::
+  :hidden:
   :maxdepth: 2
   :caption: API & CLI
 
   api
   cli
 
 .. toctree::
+  :hidden:
   :maxdepth: 2
   :caption: External Links