aidapy.data.mission.modified_cluster module

Slight modification of the cluster method from HelioPy Methods for importing data from the four Cluster spacecraft.

To download data you will need to be registered at the cluster science archive (http://www.cosmos.esa.int/web/csa/register-now), and have set either the environment variable CLUSTERCOOKIE to your cookie, or set your cookie in the heliopyrc file.

The data download method is described at https://csa.esac.esa.int/csa/aio/html/wget.shtml.

aidapy.data.mission.modified_cluster.cis_codif_h1_moms(probe, starttime, endtime, sensitivity='high', try_download=True)[source]

Load H+ moments from CIS instrument.

See https://caa.estec.esa.int/documents/UG/CAA_EST_UG_CIS_v35.pdf for more information on the CIS data.

Parameters

  • probe (string) – Probe number. Must be ‘1’, ‘2’, ‘3’, or ‘4’.

  • starttime (datetime) – Interval start.

  • endtime (datetime) – Interval end.

  • sensitivity (string, 'high' or 'low', default: 'low') – Load high or low sensitivity

Returns

data – Requested data.

Return type

DataFrame

aidapy.data.mission.modified_cluster.cis_hia_onboard_moms(probe, starttime, endtime, try_download=True)[source]

Download onboard ion moments from the CIS instrument.

See https://caa.estec.esa.int/documents/UG/CAA_EST_UG_CIS_v35.pdf for more information on the CIS data.

Parameters

  • probe (string) – Probe number. Must be ‘1’ or ‘3’

  • starttime (datetime) – Interval start.

  • endtime (datetime) – Interval end.

Returns

data – Requested data.

Return type

DataFrame

aidapy.data.mission.modified_cluster.fgm(probe, starttime, endtime, try_download=True)[source]

Download fluxgate magnetometer data.

See https://caa.estec.esa.int/documents/UG/CAA_EST_UG_FGM_v60.pdf for more information on the FGM data.

Parameters

  • probe (string) – Probe number. Must be ‘1’, ‘2’, ‘3’, or ‘4’.

  • starttime (datetime) – Interval start.

  • endtime (datetime) – Interval end.

Returns

data – Requested data.

Return type

TimeSeries

aidapy.data.mission.modified_cluster.peace_moments(probe, starttime, endtime, try_download=True)[source]

Download electron moments from the PEACE instrument.

See https://caa.estec.esa.int/documents/UG/CAA_EST_UG_PEA_v25.pdf for more information on the PEACE data.

Parameters

  • probe (string) – Probe number. Must be ‘1’, ‘2’, ‘3’, or ‘4’.

  • starttime (datetime) – Interval start.

  • endtime (datetime) – Interval end.

Returns

data – Requested data.

Return type

DataFrame