This notebook demonstrates access to the data the MITx_LP_2F, MITxTEC_2F and PPIxFAC_2F Swarm products by means of the vires client.
For each VirES data collection the avaiable variables are listed. In addition, mapping the the variables of the source the products is provided [link to product documentation TBD].
The data for the whole Swarm mission is avaiable from the production VirES server API.
from viresclient import SwarmRequest
SERVER_URL = "https://vires.services/ows"
| Collection | Dataset |
|---|---|
SW_OPER_MITA_LP_2F |
Swarm A MIT from LP - MIT minima |
SW_OPER_MITA_LP_2F:ID |
Swarm A MIT from LP - MIT boundaries ("ID" dataset) |
SW_OPER_MITB_LP_2F |
Swarm B MIT from LP - MIT minima |
SW_OPER_MITB_LP_2F:ID |
Swarm B MIT from LP - MIT boundaries ("ID" dataset) |
SW_OPER_MITC_LP_2F |
Swarm C MIT from LP - MIT minima |
SW_OPER_MITC_LP_2F:ID |
Swarm C MIT from LP - MIT boundaries ("ID" dataset) |
SW_OPER_MITx_LP_2F collections)¶Avaiables Variables:
| VirES Variable | Source Product Variable | Unit | Dimension | Description |
|---|---|---|---|---|
Counter |
Counter |
$$-$$ | vector[2] | Swarm orbit and quarter orbit counters |
Timestamp |
Timestamp |
$$-$$ | scalar | UTC time of the MIT minimum |
Latitude |
Latitude |
$$\text{deg}$$ | scalar | ITRF geocentric latitude of the MIT minimum |
Longitude |
Longitude |
$$\text{deg}$$ | scalar | ITRF geocentric longitude of the MIT minimum |
Radius |
Radius |
$$\text{m}$$ | scalar | ITRF geocentric radius of the MIT minimum |
Latitude_QD |
Latitude_QD |
$$\text{deg}$$ | scalar | Quasi-dipole latitude of the MIT minimum |
Longitude_QD |
Longitude_QD |
$$\text{deg}$$ | scalar | Quasi-dipole longitude of the MIT minimum |
MLT_QD |
MLT |
$$\text{hour}$$ | scalar | Magnetic local time (QD) of the MIT minimum |
L_value |
L_value |
$$-$$ | scalar | L-value in earth radii of the MIT minimum |
SZA |
SZA |
$$\text{deg}$$ | scalar | Solar zenith angle of the MIT minimum |
Ne |
Ne |
$$\text{cm}^{-3}$$ | scalar | LP electron density of the MIT minimum |
Te |
Te |
$$\text{K}$$ | scalar | LP electron temperature of the MIT minimum |
Depth |
Depth |
$$\text{cm}^{-3}$$ | scalar | depth of the MIT |
DR |
DR |
$$%$$ | scalar | relative change in density within the MIT |
Width |
Width |
$$\text{deg}$$ | scalar | width of the MIT calculated from QD latitudes |
dL |
dL |
$$\text{deg}$$ | scalar | width of the MIT calculated from L-values |
PW_Gradient |
PW_Gradient |
$$\log{\left(\text{cm}^{-3}\right)}\,\text{deg}^{-1}$$ | scalar | change in log electron density at the poleward wall of the MIT divided by QD latitude difference |
EW_Gradient |
PW_Gradient |
$$\log{\left(\text{cm}^{-3}\right)}\,\text{deg}^{-1}$$ | scalar | change in log electron density at the equatorward wall of the MIT divided by QD latitude difference |
Quality |
Quality |
$$-$$ | vector [8] | Characterises the detection quality of the MIT as a whole |
SW_OPER_MITx_LP_2F:ID collections)¶Avaiables Variables:
| VirES Variable | Source Product Variable | Unit | Dimension | Description |
|---|---|---|---|---|
Counter |
Counter |
$$-$$ | vector[2] | Swarm orbit and quarter orbit counters |
Timestamp |
Timestamp_ID |
$$-$$ | scalar | UTC time of the observation |
Latitude |
Latitude_ID |
$$\text{deg}$$ | scalar | ITRF geocentric latitude |
Longitude |
Longitude_ID |
$$\text{deg}$$ | scalar | ITRF geocentric longitude |
Radius |
Radius_ID |
$$\text{m}$$ | scalar | ITRF geocentric radius |
Latitude_QD |
Latitude_QD_ID |
$$\text{deg}$$ | scalar | Quasi-dipole latitude |
Longitude_QD |
Longitude_QD_ID |
$$\text{deg}$$ | scalar | Quasi-dipole longitude |
MLT_QD |
MLT_ID |
$$\text{hour}$$ | scalar | Magnetic local time (QD) |
L_value |
L_value_ID |
$$-$$ | scalar | L-value in earth radii |
SZA |
SZA_ID |
$$\text{deg}$$ | scalar | Solar zenith angle |
Ne |
Ne_ID |
$$\text{cm}^{-3}$$ | scalar | LP electron density |
Te |
Te_ID |
$$\text{K}$$ | scalar | LP electron temperature |
Position_Quality |
Position_Quality_ID |
$$-$$ | scalar | detection quality of each single position |
PointType |
n/a | $$-$$ | scalar | point type derived from the source *_ID column |
These are the possible PointType values for the MITx_LP_2F products:
| Value | Hex. | Bin. | Meaning |
|---|---|---|---|
| 0 | 0x0 | 0b0000 | LP MIT equatorward edge of the equatorward wall |
| 1 | 0x1 | 0b0001 | LP MIT poleward edge of the equatorward wall |
| 2 | 0x2 | 0b0010 | LP MIT equatorward edge of poleward wall |
| 3 | 0x3 | 0b0011 | LP MIT poleward edge of the poleward boundary |
| 4 | 0x4 | 0b0100 | LP SETE equatorward bounding position |
| 5 | 0x5 | 0b0101 | LP SETE poleward bounding position |
| 6 | 0x6 | 0b0110 | LP Te peak position |
request = SwarmRequest(SERVER_URL)
# request the default dataset
request.set_collection("SW_OPER_MITA_LP_2F")
request.set_products(
measurements=SwarmRequest.PRODUCT_VARIABLES["MIT_LP"], # request all dataset variables
auxiliaries=['QDLat', 'QDLon', 'MLT'], # QD coordinates and MLT calculated by VirES
)
data = request.get_between(
start_time="2016-01-02T00:00:00Z",
end_time="2016-01-03T00:00:00Z",
asynchronous=False,
).as_xarray()
print("Requested variables", ", ".join(SwarmRequest.PRODUCT_VARIABLES["MIT_LP:ID"]))
print("Response:", data)
# request the ID dataset
request.set_collection("SW_OPER_MITA_LP_2F:ID")
request.set_products(
measurements=SwarmRequest.PRODUCT_VARIABLES["MIT_LP:ID"], # request all dataset variables
auxiliaries=['QDLat', 'QDLon', 'MLT'], # QD coordinates and MLT calculated by VirES
)
data = request.get_between(
start_time="2016-01-02T00:00:00Z",
end_time="2016-01-03T00:00:00Z",
asynchronous=False,
).as_xarray()
print("Requested variables", ", ".join(SwarmRequest.PRODUCT_VARIABLES["MIT_LP:ID"]))
print("Response:", data)
| Collection | Dataset |
|---|---|
SW_OPER_MITATEC_2F |
Swarm A MIT from GPS TEC - MIT minima |
SW_OPER_MITATEC_2F:ID |
Swarm A MIT from GPS TEC - MIT boundaries ("ID" dataset) |
SW_OPER_MITBTEC_2F |
Swarm B MIT from GPS TEC - MIT minima |
SW_OPER_MITBTEC_2F:ID |
Swarm B MIT from GPS TEC - MIT boundaries ("ID" dataset) |
SW_OPER_MITCTEC_2F |
Swarm C MIT from GPS TEC - MIT minima |
SW_OPER_MITCTEC_2F:ID |
Swarm C MIT from GPS TEC - MIT boundaries ("ID" dataset) |
SW_OPER_MITxTEC_2F collections)¶Avaiables Variables:
| VirES Variable | Source Product Variable | Unit | Dimension | Description |
|---|---|---|---|---|
Counter |
Counter |
$$-$$ | vector[2] | Swarm orbit and quarter orbit counters |
Timestamp |
Timestamp |
$$-$$ | scalar | UTC time of the MIT minimum |
Latitude |
Latitude |
$$\text{deg}$$ | scalar | ITRF geocentric latitude of the MIT minimum |
Longitude |
Longitude |
$$\text{deg}$$ | scalar | ITRF geocentric longitude of the MIT minimum |
Radius |
Radius |
$$\text{m}$$ | scalar | ITRF geocentric radius of the MIT minimum |
Latitude_QD |
Latitude_QD |
$$\text{deg}$$ | scalar | Quasi-dipole latitude of the MIT minimum |
Longitude_QD |
Longitude_QD |
$$\text{deg}$$ | scalar | Quasi-dipole longitude of the MIT minimum |
MLT_QD |
MLT |
$$\text{hour}$$ | scalar | Magnetic local time (QD) of the MIT minimum |
L_value |
L_value |
$$-$$ | scalar | L-value in earth radii of the MIT minimum |
SZA |
SZA |
$$\text{deg}$$ | scalar | Solar zenith angle of the MIT minimum |
TEC |
TEC |
$$\text{TECU}$$ | scalar | Total electron content at the MIT minimum |
Depth |
Depth |
$$\text{cm}^{-3}$$ | scalar | depth of the MIT |
DR |
DR |
$$%$$ | scalar | relative change in density within the MIT |
Width |
Width |
$$\text{deg}$$ | scalar | width of the MIT calculated from QD latitudes |
dL |
dL |
$$\text{deg}$$ | scalar | width of the MIT calculated from L-values |
PW_Gradient |
PW_Gradient |
$$\text{TECU}\,\text{deg}^{-1}$$ | scalar | change in log electron density at the poleward wall of the MIT divided by QD latitude difference |
EW_Gradient |
PW_Gradient |
$$\text{TECU}\,\text{deg}^{-1}$$ | scalar | change in log electron density at the equatorward wall of the MIT divided by QD latitude difference |
Quality |
Quality |
$$-$$ | vector [8] | Characterises the detection quality of the MIT as a whole |
SW_OPER_MITxTEC_2F:ID collections)¶Avaiables Variables:
| VirES Variable | Source Product Variable | Unit | Dimension | Description |
|---|---|---|---|---|
Counter |
Counter |
$$-$$ | vector[2] | Swarm orbit and quarter orbit counters |
Timestamp |
Timestamp_ID |
$$-$$ | scalar | UTC time of the observation |
Latitude |
Latitude_ID |
$$\text{deg}$$ | scalar | ITRF geocentric latitude |
Longitude |
Longitude_ID |
$$\text{deg}$$ | scalar | ITRF geocentric longitude |
Radius |
Radius_ID |
$$\text{m}$$ | scalar | ITRF geocentric radius |
Latitude_QD |
Latitude_QD_ID |
$$\text{deg}$$ | scalar | Quasi-dipole latitude |
Longitude_QD |
Longitude_QD_ID |
$$\text{deg}$$ | scalar | Quasi-dipole longitude |
MLT_QD |
MLT_ID |
$$\text{hour}$$ | scalar | Magnetic local time (QD) |
L_value |
L_value_ID |
$$-$$ | scalar | L-value in earth radii |
SZA |
SZA_ID |
$$\text{deg}$$ | scalar | Solar zenith angle |
TEC |
TEC_ID |
$$\text{TECU}$$ | scalar | Total electron content |
Position_Quality |
Position_Quality_ID |
$$-$$ | scalar | detection quality of each single position |
PointType |
n/a | $$-$$ | scalar | point type derived from the source *_ID column |
These are the possible PointType values for the MITxTEC_2F products:
| Value | Hex. | Bin. | Meaning |
|---|---|---|---|
| 0 | 0x0 | 0b0000 | TEC MIT equatorward edge of the equatorward wall |
| 1 | 0x1 | 0b0001 | TEC MIT poleward edge of the equatorward wall |
| 2 | 0x2 | 0b0010 | TEC MIT equatorward edge of poleward wall |
| 3 | 0x3 | 0b0011 | TEC MIT poleward edge of the poleward boundary |
request = SwarmRequest(SERVER_URL)
# request the default dataset
request.set_collection("SW_OPER_MITATEC_2F")
request.set_products(
measurements=SwarmRequest.PRODUCT_VARIABLES["MIT_TEC"], # request all dataset variables
auxiliaries=['QDLat', 'QDLon', 'MLT'], # QD coordinates and MLT calculated by VirES
)
data = request.get_between(
start_time="2016-01-02T00:00:00Z",
end_time="2016-01-03T00:00:00Z",
asynchronous=False,
).as_xarray()
print("Requested variables", ", ".join(SwarmRequest.PRODUCT_VARIABLES["MIT_TEC:ID"]))
print("Response:", data)
# request the ID dataset
request.set_collection("SW_OPER_MITATEC_2F:ID")
request.set_products(
measurements=SwarmRequest.PRODUCT_VARIABLES["MIT_TEC:ID"], # request all dataset variables
auxiliaries=['QDLat', 'QDLon', 'MLT'], # QD coordinates and MLT calculated by VirES
)
data = request.get_between(
start_time="2016-01-02T00:00:00Z",
end_time="2016-01-03T00:00:00Z",
asynchronous=False,
).as_xarray()
print("Requested variables", ", ".join(SwarmRequest.PRODUCT_VARIABLES["MIT_TEC:ID"]))
print("Response:", data)
| Collection | Dataset |
|---|---|
SW_OPER_PPIAFAC_2F |
Swarm A PPI and SSFAC boundaries |
SW_OPER_PPIAFAC_2F:ID |
Swarm A edges of the SSFAC boundaries ("ID" dataset) |
SW_OPER_PPIBFAC_2F |
Swarm B PPI and SSFAC boundaries |
SW_OPER_PPIBFAC_2F:ID |
Swarm B edges of the SSFAC boundaries ("ID" dataset) |
SW_OPER_PPICFAC_2F |
Swarm C PPI and SSFAC boundaries |
SW_OPER_PPICFAC_2F:ID |
Swarm C edges of the SSFAC boundaries ("ID" dataset) |
SW_OPER_PPIxFAC_2F collections)¶Avaiables Variables:
| VirES Variable | Source Product Variable | Unit | Dimension | Description |
|---|---|---|---|---|
Counter |
Counter |
$$-$$ | vector[2] | Swarm orbit and quarter orbit counters |
Timestamp |
Timestamp |
$$-$$ | scalar | UTC time of the SSFAC boundary |
Latitude |
Latitude |
$$\text{deg}$$ | scalar | ITRF geocentric latitude of the SSFAC boundary |
Longitude |
Longitude |
$$\text{deg}$$ | scalar | ITRF geocentric longitude of the SSFAC boundary |
Radius |
Radius |
$$\text{m}$$ | scalar | ITRF geocentric radius of the SSFAC boundary |
Latitude_QD |
Latitude_QD |
$$\text{deg}$$ | scalar | Quasi-dipole latitude of the SSFAC boundary |
Longitude_QD |
Longitude_QD |
$$\text{deg}$$ | scalar | Quasi-dipole longitude of the SSFAC boundary |
MLT_QD |
MLT |
$$\text{hour}$$ | scalar | Magnetic local time (QD) of the SSFAC boundary |
L_value |
L_value |
$$-$$ | scalar | L-value in earth radii of the SSFAC boundary |
SZA |
SZA |
$$\text{deg}$$ | scalar | Solar zenith angle of the SSFAC boundary |
Sigma |
Sigma |
$$-$$ | scalar | Standard deviation of the linear fit of S at the boundary |
PPI |
PPI |
$$\text{R_E}$$ | scalar | midnight plasmapause index |
dL |
dL |
$$\text{deg}$$ | scalar | boundary width in Earth radii |
Quality |
Quality |
$$-$$ | vector [7] | Quality indicators of SSFAC boundary detection |
SW_OPER_PPIxFAC_2F:ID collections)¶Avaiables Variables:
| VirES Variable | Source Product Variable | Unit | Dimension | Description |
|---|---|---|---|---|
Counter |
Counter |
$$-$$ | vector[2] | Swarm orbit and quarter orbit counters |
Timestamp |
Timestamp_ID |
$$-$$ | scalar | UTC time of the observation |
Latitude |
Latitude_ID |
$$\text{deg}$$ | scalar | ITRF geocentric latitude |
Longitude |
Longitude_ID |
$$\text{deg}$$ | scalar | ITRF geocentric longitude |
Radius |
Radius_ID |
$$\text{m}$$ | scalar | ITRF geocentric radius |
Latitude_QD |
Latitude_QD_ID |
$$\text{deg}$$ | scalar | Quasi-dipole latitude |
Longitude_QD |
Longitude_QD_ID |
$$\text{deg}$$ | scalar | Quasi-dipole longitude |
MLT_QD |
MLT_ID |
$$\text{hour}$$ | scalar | Magnetic local time (QD) |
L_value |
L_value_ID |
$$-$$ | scalar | L-value in earth radii |
SZA |
SZA_ID |
$$\text{deg}$$ | scalar | Solar zenith angle |
Position_Quality |
Position_Quality_ID |
$$-$$ | scalar | detection quality of each single position |
PointType |
n/a | $$-$$ | scalar | point type derived from the source *_ID column |
These are the possible PointType values for the PPIxFAC_2F products:
| Value | Hex. | Bin. | Meaning |
|---|---|---|---|
| 0 | 0x0 | 0b0000 | equatorward edge of SSFAC boundary |
| 1 | 0x1 | 0b0001 | poleward edge of SSFAC boundary |
request = SwarmRequest(SERVER_URL)
# request the default dataset
request.set_collection("SW_OPER_PPIAFAC_2F")
request.set_products(
measurements=SwarmRequest.PRODUCT_VARIABLES["PPI_FAC"], # request all dataset variables
auxiliaries=['QDLat', 'QDLon', 'MLT'], # QD coordinates and MLT calculated by VirES
)
data = request.get_between(
start_time="2016-01-02T00:00:00Z",
end_time="2016-01-03T00:00:00Z",
asynchronous=False,
).as_xarray()
print("Requested variables", ", ".join(SwarmRequest.PRODUCT_VARIABLES["PPI_FAC:ID"]))
print("Response:", data)
# request the ID dataset
request.set_collection("SW_OPER_PPIAFAC_2F:ID")
request.set_products(
measurements=SwarmRequest.PRODUCT_VARIABLES["PPI_FAC:ID"], # request all dataset variables
auxiliaries=['QDLat', 'QDLon', 'MLT'], # QD coordinates and MLT calculated by VirES
)
data = request.get_between(
start_time="2016-01-02T00:00:00Z",
end_time="2016-01-03T00:00:00Z",
asynchronous=False,
).as_xarray()
print("Requested variables", ", ".join(SwarmRequest.PRODUCT_VARIABLES["PPI_FAC:ID"]))
print("Response:", data)