Skip to content

Commit 9aa61fe

Browse files
smitharapacesm
smithara
and
pacesm
authored
Version 0.9.0 (#66)
* Add missing dDst auxiliary configuration * Add progress bar for chunks * 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 <[email protected]> * Add support for external mission MAG products (#65) * Various fixes needed to support the long-term VOBS data collections. * Add config for VOBS & .as_xarray(reshape=True) opt * Fix package installation * Add model evaluation for data without B_NEC/F vars * Fix xarray coord attrs * Try fix shell detection * Adding VOBS secular variations. * Minimal changes to work with non-Swarm MAG data. * Allowing model requests for B_NEC[123] variables * Support for multiple missions in SwarmRequest.get_times_for_orbits() method. * Adding GRACE and GRACE-FO spacecrafts. * Support for CryoSat-2 missions in SwarmRequest.get_times_for_orbits() method. * Implementing residuals for the CryoSat-2 B_NEC[123] variables. * Add configuration for Cryosat-2, GRACE, GRACE-FO * Add multi-mission mag products to docs Co-authored-by: Martin Paces <[email protected]> * Update set of VOBS products * Add access to Swarm positions, MODx_SC * Update scientific references for collections * Remove now unused user/password configuration * Remove nbsphinx dependency from docs * Adjust get_orbit_number for multi-mission data * Add missing F variable for MAG_GFO * Bump to version 0.9.0 for release Co-authored-by: Martin Paces <[email protected]>
1 parent c123647 commit 9aa61fe

14 files changed

+438
-164
lines changed

‎docs/available_parameters.rst

+42-6
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ SW_OPER_FACxTMS_2F FAC Field-aligned currents (single satelli
4646
SW_OPER_FAC_TMS_2F FAC Field-aligned currents (dual-satellite A-C)
4747
SW_OPER_EEFxTMS_2F EEF Equatorial electric field
4848
SW_OPER_IBIxTMS_2F IBI Ionospheric bubble index
49+
SW_OPER_MODx_SC_1B MOD_SC Spacecraft positions at 1Hz
4950
======================== ================ ==============================================================
5051

5152
The AEBS (auroral electrojets and boundaries) products are a bit more complicated:
@@ -63,6 +64,19 @@ SW_OPER_AEJxPBS_2F:GroundMagneticDisturbance AEJ_PBS:GroundMagneticDisturbance -
6364
SW_OPER_AOBxFAC_2F AOB_FAC Auroral oval boundaries derived from FACs
6465
============================================ ================================= ==============================================================
6566

67+
The PRISM (Plasmapause Related boundaries in the topside Ionosphere as derived from Swarm Measurements) products are provided as:
68+
69+
====================== ================ ===================================================================================================
70+
Collection full name Collection type Description
71+
====================== ================ ===================================================================================================
72+
SW_OPER_MITx_LP_2F MIT_LP Minima of the Midlatitude Ionospheric Trough (MIT) - derived from Langmuir Probe (LP) measurements
73+
SW_OPER_MITx_LP_2F:ID MIT_LP:ID -> Boundaries of the MIT - derived from the LP
74+
SW_OPER_MITxTEC_2F MIT_TEC Minima of the MIT - derived from Total Electron Content (TEC)
75+
SW_OPER_MITxTEC_2F:ID MIT_TEC:ID -> Boundaries of the MIT - derived from TEC
76+
SW_OPER_PPIxFAC_2F PPI_FAC Midnight Plasmapause Index (PPI)
77+
SW_OPER_PPIxFAC_2F:ID PPI_FAC:ID -> Boundaries of the Small-Scale Field Aligned Currents (SSFAC)
78+
====================== ================ ===================================================================================================
79+
6680
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.
6781

6882
======================== ================ ==============================================================
@@ -81,6 +95,10 @@ The VOBS collections contain derived magnetic measurements from `Geomagnetic Vir
8195
Collection full name Collection type Description
8296
==================================== =========================== ==========================================================================
8397
SW_OPER_VOBS_1M_2\_ VOBS_SW_1M Swarm (1-monthly cadence)
98+
OR_OPER_VOBS_1M_2\_ VOBS_OR_1M Ørsted (1-monthly cadence)
99+
CH_OPER_VOBS_1M_2\_ VOBS_CH_1M CHAMP (1-monthly)
100+
CR_OPER_VOBS_1M_2\_ VOBS_CR_1M Cryosat-2 (1-monthly)
101+
CO_OPER_VOBS_1M_2\_ VOBS_CO_1M Composite time series from Ørsted, CHAMP, Cryosat-2, & Swarm (1-monthly)
84102
SW_OPER_VOBS_4M_2\_ VOBS_SW_4M Swarm (4-monthly)
85103
OR_OPER_VOBS_4M_2\_ VOBS_OR_4M Ørsted (4-monthly)
86104
CH_OPER_VOBS_4M_2\_ VOBS_CH_4M CHAMP (4-monthly)
@@ -92,6 +110,16 @@ SW_OPER_VOBS_1M_2\_:SecularVariation VOBS_SW_1M:SecularVariation Secular variati
92110

93111
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``.
94112

113+
Calibrated magnetic data are also available from external missions: Cryosat-2, GRACE (A+B), GRACE-FO (1+2):
114+
115+
=============================== ================ =========================================================================================================
116+
Collection full name Collection type Available measurement names
117+
=============================== ================ =========================================================================================================
118+
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``
119+
GRACE_x_MAG (x=A/B) MAG_GRACE ``F,B_NEC,B_NEC_raw,B_FGM,B_mod_NEC,q_NEC_CRF,q_error``
120+
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``
121+
=============================== ================ =========================================================================================================
122+
95123
The ``measurements``, ``models``, and ``auxiliaries`` chosen will match the cadence of the ``collection`` chosen.
96124

97125
----
@@ -129,6 +157,19 @@ AEJ_PBS:GroundMagneticDisturbance ``B_NE``
129157
AOB_FAC ``Latitude_QD,Longitude_QD,MLT_QD,Boundary_Flag,Quality,Pair_Indicator``
130158
================================= ================================================================================
131159

160+
PRISM products:
161+
162+
================ ================================================================================================================
163+
Collection type Available measurement names
164+
================ ================================================================================================================
165+
MIT_LP ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,Ne,Te,Depth,DR,Width,dL,PW_Gradient,EW_Gradient,Quality``
166+
MIT_LP:ID ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,Ne,Te,Position_Quality,PointType``
167+
MIT_TEC ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,TEC,Depth,DR,Width,dL,PW_Gradient,EW_Gradient,Quality``
168+
MIT_TEC:ID ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,TEC,Position_Quality,PointType``
169+
PPI_FAC ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,Sigma,PPI,dL,Quality``
170+
PPI_FAC:ID ``Counter,Latitude_QD,Longitude_QD,MLT_QD,L_value,SZA,Position_Quality,PointType``
171+
================ ================================================================================================================
172+
132173
AUX_OBS products:
133174

134175
=============== =========================================
@@ -147,11 +188,6 @@ VOBS products:
147188
Collection full name Available measurement names
148189
==================================== ===========================================
149190
SW_OPER_VOBS_1M_2\_ ``SiteCode,B_CF,B_OB,sigma_CF,sigma_OB``
150-
SW_OPER_VOBS_4M_2\_ ``SiteCode,B_CF,B_OB,sigma_CF,sigma_OB``
151-
OR_OPER_VOBS_4M_2\_ ``SiteCode,B_CF,B_OB,sigma_CF,sigma_OB``
152-
CH_OPER_VOBS_4M_2\_ ``SiteCode,B_CF,B_OB,sigma_CF,sigma_OB``
153-
CR_OPER_VOBS_4M_2\_ ``SiteCode,B_CF,B_OB,sigma_CF,sigma_OB``
154-
CO_OPER_VOBS_4M_2\_ ``SiteCode,B_CF,B_OB,sigma_CF,sigma_OB``
155191
SW_OPER_VOBS_1M_2\_:SecularVariation ``SiteCode,B_SV,sigma_SV``
156192
(ditto for the others)
157193
==================================== ===========================================
@@ -234,7 +270,7 @@ NB: When using model names containing a hyphen (``-``) then extra single (``'``)
234270

235271
::
236272

237-
SyncStatus, Kp10, Kp, Dst, IMF_BY_GSM, IMF_BZ_GSM, IMF_V, F107, F10_INDEX,
273+
SyncStatus, Kp10, Kp, Dst, dDst, IMF_BY_GSM, IMF_BZ_GSM, IMF_V, F107, F10_INDEX,
238274
OrbitDirection, QDOrbitDirection,
239275
OrbitSource, OrbitNumber, AscendingNodeTime,
240276
AscendingNodeLongitude, QDLat, QDLon, QDBasis, MLT, SunDeclination,

‎docs/cli.rst

+4
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ Show current configuration::
3535
$ viresclient show_configuration
3636
...
3737

38+
Remove stored configuration::
39+
40+
$ viresclient clear_credentials
41+
3842
2. Data Upload
3943
--------------
4044

‎docs/conf.py

-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@
4848
extensions = [
4949
'sphinx.ext.autodoc',
5050
'sphinx.ext.napoleon',
51-
'nbsphinx',
5251
'sphinx.ext.imgmath',
5352
'sphinx.ext.autosectionlabel',
5453
'sphinx.ext.viewcode',

‎docs/config_details.rst

+3-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Configuration Details
22
=====================
33

4+
.. note::
5+
Be careful not to accidentally add your credentials to online repositories or containers. You can use the CLI command ``viresclient clear_credentials`` to remove them.
6+
47
While it is possible to enter the server URL and access credentials (see :doc:`access_token`) each time a new request object is created,
58

69
.. code-block:: python
@@ -103,11 +106,3 @@ Using ``SwarmRequest()`` without the ``url`` parameter will use the default URL
103106
104107
# request to an alternative, non-default server
105108
request = SwarmRequest(url="https://staging.viresdisc.vires.services/ows")
106-
107-
The older HTTP basic access authentication (i.e. username + password) is still available on the DICS staging server and these credentials can also be configured::
108-
109-
$ viresclient set_password https://staging.viresdisc.vires.services/openows
110-
Enter username [jovyan]: <username>
111-
Enter password: ***********
112-
113-
However, this interface is deprecated and it will be removed in future and it is recommended to switch to the token-based authentication.

‎docs/docs_requirements.txt

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
pygments>=2.4.1
2-
nbsphinx
3-
ipykernel
4-
2+
sphinx_rtd_theme
53
Jinja2
64
pandas
75
cdflib

‎docs/release_notes.rst

+13
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@ Release notes
44
Change log
55
----------
66

7+
Changes from 0.8.0 to 0.9.0
8+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
9+
10+
- Added support for:
11+
12+
- PRISM products (``SW_OPER_MITx_LP_2F``, ``SW_OPER_MITxTEC_2F``, ``SW_OPER_PPIxFAC_2F``)
13+
- Multi-mission magnetic products (``CS_OPER_MAG``, ``GRACE_x_MAG``, ``GFx_OPER_FGM_ACAL_CORR``)
14+
- Swarm spacecraft positions (``SW_OPER_MODx_SC_1B``)
15+
16+
- Fixed missing auxiliary "dDst"
17+
- Fixed fetching longer time series of hourly observatory products
18+
- Added new progress bar that tracks processing of chunks in long requests
19+
720
Changes from 0.7.2 to 0.8.0
821
^^^^^^^^^^^^^^^^^^^^^^^^^^^
922

‎viresclient/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@
3737
from . import _data
3838

3939

40-
__version__ = "0.8.0"
40+
__version__ = "0.9.0"

0 commit comments

Comments
 (0)