Available parameters for Swarm data¶
You can check which parameters are available with:
from viresclient import SwarmRequest req = SwarmRequest() req.available_collections() req.available_measurements("MAG") req.available_models() req.available_auxiliaries()
The available measurements are segregated according to the “collection” (essentially Swarm products): each
collection has a number of
measurements associated with it, and the appropriate collection must be set in order to access the measurements.
auxiliaries are available together with any set
models provide magnetic model evaluation on demand, at the locations of the time series which is being accessed.
See the Swarm Data Handbook for details about the products.
(replace x with A, B, or C for Alpha, Bravo, or Charlie):
SW_OPER_MAGx_LR_1B SW_OPER_MAGx_HR_1B SW_OPER_EFIx_LP_1B SW_OPER_IBIxTMS_2F SW_OPER_TECxTMS_2F SW_OPER_FACxTMS_2F SW_OPER_EEFxTMS_2F SW_OPER_IPDxIRR_2F
For Alpha-Charlie FAC:
auxiliaries chosen will match the cadence of the
Choose combinations of measurements from one of the following sets, corresponding to the collection chosen above.
For MAG and
Models are evaluated along the satellite track at the positions of the time series that has been requested. These must be used together with one of the MAG collections, and one or both of the “F” and “B_NEC” measurements. This can yield either the model values together with the measurements, or the data-model residuals.
For a good estimate of the ionospheric field measured by a Swarm satellite (with the core, crust and magnetosphere effects removed) use a composed model defined as:
models=["'CHAOS-full' = 'CHAOS-Core' + 'CHAOS-Static' + 'CHAOS-MMA-Primary' + 'CHAOS-MMA-Secondary'"]
(click for more info)
This composed model can also be accessed by an alias:
models=["CHAOS"] which represents the full CHAOS model
See https://magneticearth.org for an overview introduction to geomagnetic models.
IGRF, # Comprehensive inversion (CI) models: MCO_SHA_2C, # Core MLI_SHA_2C, # Lithosphere MMA_SHA_2C-Primary, MMA_SHA_2C-Secondary, # Magnetosphere MIO_SHA_2C-Primary, MIO_SHA_2C-Secondary, # Ionosphere # Dedicated inversion models: MCO_SHA_2D, MLI_SHA_2D, MIO_SHA_2D-Primary, MIO_SHA_2D-Secondary AMPS # Fast-track models: MMA_SHA_2F-Primary, MMA_SHA_2F-Secondary, # CHAOS models: CHAOS-Core, CHAOS-Static, CHAOS-MMA-Primary, CHAOS-MMA-Secondary # Other lithospheric models: MF7, LCS-1 # Aliases for compositions of the above models (shortcuts) MCO_SHA_2X # 'CHAOS-Core' CHAOS-MMA # 'CHAOS-MMA-Primary' + 'CHAOS-MMA-Secondary' CHAOS # 'CHAOS-Core' + 'CHAOS-Static' + 'CHAOS-MMA-Primary' + 'CHAOS-MMA-Secondary' MMA_SHA_2F # 'MMA_SHA_2F-Primary' + 'MMA_SHA_2F-Secondary' MMA_SHA_2C # 'MMA_SHA_2C-Primary' + 'MMA_SHA_2C-Secondary' MIO_SHA_2C # 'MIO_SHA_2C-Primary' + 'MIO_SHA_2C-Secondary' MIO_SHA_2D # 'MIO_SHA_2D-Primary' + 'MIO_SHA_2D-Secondary' SwarmCI # 'MCO_SHA_2C' + 'MLI_SHA_2C' + 'MIO_SHA_2C-Primary' + 'MIO_SHA_2C-Secondary' + 'MMA_SHA_2C-Primary' + 'MMA_SHA_2C-Secondary'
Custom (user uploaded) models can be provided as a .shc file and become accessible in the same way as pre-defined models, under the name
Flexible evaluation of models and defining new derived models is possible with the “model expressions” functionality whereby models can be defined like:
request.set_products( ... models=["Combined_model = 'MMA_SHA_2F-Primary'(min_degree=1,max_degree=1) + 'MMA_SHA_2F-Secondary'(min_degree=1,max_degree=1)"], ... )
In this case, model evaluations will then be available in the returned data under the name “Combined_model”, but you can name it however you like.
NB: When using model names containing a hyphen (
-) then extra single (
') or double (
") quotes must be used around the model name. This is to distinguish from arithmetic minus (
SyncStatus, Kp10, Kp, Dst, IMF_BY_GSM, IMF_BZ_GSM, IMF_V, F107, F10_INDEX, OrbitDirection, QDOrbitDirection, OrbitSource, OrbitNumber, AscendingNodeTime, AscendingNodeLongitude, QDLat, QDLon, QDBasis, MLT, SunDeclination, SunHourAngle, SunRightAscension, SunAzimuthAngle, SunZenithAngle, SunLongitude, SunVector, DipoleAxisVector, NGPLatitude, NGPLongitude, DipoleTiltAngle
- The AMPS model is currently accessible as “auxiliaries” instead of a “model” (On the DISC server it is now accessible as a regular model)
Kpprovides the Kp values in fractional form (e.g 2.2), and
Kp10is multiplied by 10 (as integers)
F107is the hourly 10.7 cm solar radio flux value, and
F10_INDEXis the daily average
QDLonare quasi-dipole coordinates
QDOrbitDirectionflags indicate if the satellite is moving towards or away from each pole, respectively for geographic and quasi-dipole magnetic poles. +1 for ascending, and -1 for descending (in latitude); 0 for no data.
Standard positional variables always returned: