Supported Instruments

C/NOFS IVM

Supports the Ion Velocity Meter (IVM) onboard the Communication and Navigation Outage Forecasting System (C/NOFS) satellite, part of the Coupled Ion Netural Dynamics Investigation (CINDI). Downloads data from the NASA Coordinated Data Analysis Web (CDAWeb) in CDF format.

The IVM is composed of the Retarding Potential Analyzer (RPA) and Drift Meter (DM). The RPA measures the energy of plasma along the direction of satellite motion. By fitting these measurements to a theoretical description of plasma the number density, plasma composition, plasma temperature, and plasma motion may be determined. The DM directly measures the arrival angle of plasma. Using the reported motion of the satellite the angle is converted into ion motion along two orthogonal directions, perpendicular to the satellite track.

References

A brief discussion of the C/NOFS mission and instruments can be found at de La Beaujardière, O., et al. (2004), C/NOFS: A mission to forecast scintillations, J. Atmos. Sol. Terr. Phys., 66, 1573–1591, doi:10.1016/j.jastp.2004.07.030.

Discussion of cleaning parameters for ion drifts can be found in: Burrell, Angeline G., Equatorial topside magnetic field-aligned ion drifts at solar minimum, The University of Texas at Dallas, ProQuest Dissertations Publishing, 2012. 3507604.

Discussion of cleaning parameters for ion temperature can be found in: Hairston, M. R., W. R. Coley, and R. A. Heelis (2010), Mapping the duskside topside ionosphere with CINDI and DMSP, J. Geophys. Res.,115, A08324, doi:10.1029/2009JA015051.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘cnofs’
name
‘ivm’
tag
None supported
sat_id
None supported

Warning

  • The sampling rate of the instrument changes on July 29th, 2010. The rate is attached to the instrument object as .sample_rate.
  • The cleaning parameters for the instrument are still under development.

C/NOFS PLP

Supports the Planar Langmuir Probe (PLP) onboard the Communication and Navigation Outage Forecasting System (C/NOFS) satellite. Downloads data from the NASA Coordinated Data Analysis Web (CDAWeb).

Description from CDAWeb:

The Planar Langmuir Probe on C/NOFS is a suite of 2 current measuring sensors mounted on the ram facing surface of the spacecraft. The primary sensor is an Ion Trap (conceptually similar to RPAs flown on many other spacecraft) capable of measuring ion densities as low as 1 cm-3 with a 12 bit log electrometer. The secondary senor is a swept bias planar Langmuir probe (Surface Probe) capable of measuring Ne, Te, and spacecraft potential.

The ion number density is the one second average of the ion density sampled at either 32, 256, 512, or 1024 Hz (depending on the mode).

The ion density standard deviation is the standard deviation of the samples used to produce the one second average number density.

DeltaN/N is the detrened ion number density 1 second standard deviation divided by the mean 1 sec density.

The electron density, electron temperature, and spacecraft potential are all derived from a least squares fit to the current-bias curve from the Surface Probe.

The data is PRELIMINARY, and as such, is intended for BROWSE PURPOSES ONLY.

References

A brief discussion of the C/NOFS mission and instruments can be found at de La Beaujardière, O., et al. (2004), C/NOFS: A mission to forecast scintillations, J. Atmos. Sol. Terr. Phys., 66, 1573–1591, doi:10.1016/j.jastp.2004.07.030.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘cnofs’
name
‘plp’
tag
None supported
sat_id
None supported

Warning

  • The data are PRELIMINARY, and as such, are intended for BROWSE PURPOSES ONLY.
  • Currently no cleaning routine.
  • Module not written by PLP team.

C/NOFS VEFI

Supports the Vector Electric Field Instrument (VEFI) onboard the Communication and Navigation Outage Forecasting System (C/NOFS) satellite. Downloads data from the NASA Coordinated Data Analysis Web (CDAWeb).

Description from CDAWeb:

The DC vector magnetometer on the CNOFS spacecraft is a three axis, fluxgate sensor with active thermal control situated on a 0.6m boom. This magnetometer measures the Earth’s magnetic field using 16 bit A/D converters at 1 sample per sec with a range of .. 45,000 nT. Its primary objective on the CNOFS spacecraft is to enable an accurate V x B measurement along the spacecraft trajectory. In order to provide an in-flight calibration of the magnetic field data, we compare the most recent POMME model (the POtsdam Magnetic Model of the Earth, http://geomag.org/models/pomme5.html) with the actual magnetometer measurements to help determine a set of calibration parameters for the gains, offsets, and non-orthogonality matrix of the sensor axes. The calibrated magnetic field measurements are provided in the data file here. The VEFI magnetic field data file currently contains the following variables: B_north Magnetic field in the north direction B_up Magnetic field in the up direction B_west Magnetic field in the west direction

The data is PRELIMINARY, and as such, is intended for BROWSE PURPOSES ONLY.

References

A brief discussion of the C/NOFS mission and instruments can be found at de La Beaujardière, O., et al. (2004), C/NOFS: A mission to forecast scintillations, J. Atmos. Sol. Terr. Phys., 66, 1573–1591, doi:10.1016/j.jastp.2004.07.030.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘cnofs’
name
‘vefi’
tag
Select measurement type, one of {‘dc_b’}
sat_id
None supported

Note

  • tag = ‘dc_b’: 1 second DC magnetometer data

Warning

  • The data is PRELIMINARY, and as such, is intended for BROWSE PURPOSES ONLY.
  • Limited cleaning routine.
  • Module not written by VEFI team.

CHAMP-STAR

Supports the Spatial Triaxial Accelerometer for Research (STAR) instrument onboard the Challenging Minipayload (CHAMP) satellite. Accesses local data in ASCII format.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatIncubator (https://github.com/pysat/pysatIncubator)

Properties

platform
‘champ’
name
‘star’
tag
None supported
sat_id
None supported

Warning

  • The cleaning parameters for the instrument are still under development.

Authors

Angeline G. Burrell, Feb 22, 2016, University of Leicester

COSMIC GPS

Loads data from the COSMIC satellite.

The Constellation Observing System for Meteorology, Ionosphere, and Climate (COSMIC) is comprised of six satellites in LEO with GPS receivers. The occultation of GPS signals by the atmosphere provides a measurement of atmospheric parameters. Data downloaded from the COSMIC Data Analaysis and Archival Center.

Default behavior is to search for the 2013 re-processed data first, then the post-processed data as recommended on https://cdaac-www.cosmic.ucar.edu/cdaac/products.html

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatCDAAC (https://github.com/pysat/pysatCDAAC)

Properties

platform
‘cosmic’
name
‘gps’ for Radio Occultation profiles
tag
Select profile type, or scintillation, one of: {‘ionprf’, ‘sonprf’, ‘wetprf’, ‘atmprf’, ‘scnlv1’}
sat_id
None supported
altitude_bin
Number of kilometers to bin altitude profiles by when loading. Currently only supported for tag=’ionprf’.

Note

  • ‘ionprf: ‘ionPrf’ ionosphere profiles
  • ‘sonprf’: ‘sonPrf’ files
  • ‘wetprf’: ‘wetPrf’ files
  • ‘atmprf’: ‘atmPrf’ files
  • ‘scnlv1’: ‘scnLv1’ files

Warning

  • Routine was not produced by COSMIC team

  • More recent versions of netCDF4 and numpy limit the casting of some variable types into others. This issue could prevent data loading for some variables such as ‘MSL_Altitude’ in the ‘sonprf’ and ‘wetprf’ files. The default UserWarning when this occurs is

    ‘UserWarning: WARNING: missing_value not used since it cannot be safely cast to variable data type’

DE2 LANG

Supports the Langmuir Probe (LANG) instrument on Dynamics Explorer 2 (DE2).

From CDAWeb:

The Langmuir Probe Instrument (LANG) was a cylindrical electrostatic probe that obtained measurements of electron temperature, Te, and electron or ion concentration, Ne or Ni, respectively, and spacecraft potential. Data from this investigation were used to provide temperature and density measurements along magnetic field lines related to thermal energy and particle flows within the magnetosphere-ionosphere system, to provide thermal plasma conditions for wave-particle interactions, and to measure large-scale and fine-structure ionospheric effects of energy deposition in the ionosphere. The Langmuir Probe instrument was identical to that used on the AE satellites and the Pioneer Venus Orbiter. Two independent sensors were connected to individual adaptive sweep voltage circuits which continuously tracked the changing electron temperature and spacecraft potential, while autoranging electrometers adjusted their gain in response to the changing plasma density. The control signals used to achieve this automatic tracking provided a continuous monitor of the ionospheric parameters without telemetering each volt-ampere (V-I) curve. Furthermore, internal data storage circuits permitted high resolution, high data rate sampling of selected V-I curves for transmission to ground to verify or correct the inflight processed data. Time resolution was 0.5 seconds.

References

J. P. Krehbiel, L. H. Brace, R. F. Theis, W. H. Pinkus, and R. B. Kaplan, The Dynamics Explorer 2 Langmuir Probe (LANG), Space Sci. Instrum., v. 5, n. 4, p. 493, 1981.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘de2’
name
‘lang’
sat_id
None Supported
tag
None Supported

Authors

  1. Klenzing

DE2 NACS

Supports the Neutral Atmosphere Composition Spectrometer (NACS) instrument on Dynamics Explorer 2 (DE2).

From CDAWeb:

The Neutral Atmosphere Composition Spectrometer (NACS) was designed to obtain in situ measurements of the neutral atmospheric composition and to study the variations of the neutral atmosphere in response to energy coupled into it from the magnetosphere. Because temperature enhancements, large-scale circulation cells, and wave propagation are produced by energy input (each of which posseses a specific signature in composition variation), the measurements permitted the study of the partition, flow, and deposition of energy from the magnetosphere. Specifically, the investigation objective was to characterize the composition of the neutral atmosphere with particular emphasis on variability in constituent densities driven by interactions in the atmosphere, ionosphere, and magnetosphere system. The quadrupole mass spectrometer used was nearly identical to those flown on the AE-C, -D, and -E missions. The electron- impact ion source was used in a closed mode. Atmospheric particles entered an antechamber through a knife-edged orifice, where they were thermalized to the instrument temperature. The ions with the selected charge-to-mass ratios had stable trajectories through the hyperbolic electric field, exited the analyzer, and entered the detection system. An off-axis beryllium-copper dynode multiplier operating at a gain of 2.E6 provided an output pulse of electrons for each ion arrival. The detector output had a pulse rate proportional to the neutral density in the ion source of the selected mass. The instrument also included two baffles that scanned across the input orifice for optional measurement of the zonal and vertical components of the neutral wind. The mass select system provided for 256 mass values between 0 and 51 atomic mass units (u) or each 0.2 u. It was possible to call any one of these mass numbers into each of eight 0.016-s intervals. This sequence was repeated each 0.128 s.

This data set includes daily files of the PI-provided DE-2 NACS 1-second data and corresponding orbit parameters. The data set was generated at NSSDC from the original PI-provided data and software (SPTH-00010) and from the orbit/attitude database and software that is part of the DE-2 UA data set (SPIO-00174). The original NACS data were provided by the PI team in a highly compressed VAX/VMS binary format on magnetic tapes. The data set covers the whole DE-2 mission time period. Each data point is an average over the normally 8 measurements per second. Densities and relative errors are provided for atomic oxygen (O), molecular nitrogen (N2), helium (He), atomic nitrogen (N), and argon (Ar). The data quality is generally quite good below 500 km, but deteriorates towards higher altitudes as oxygen and molecular nitrogen approach their background values (which could only be determined from infrequent spinning orbits) and the count rate for Ar becomes very low. The difference between minimum (background) and maximum count rate for atomic nitrogen (estimated from mass 30) was so small that results are generally poor. Data were lost between 12 March 1982 and 31 March 1982 when the counter overflowed.

References

G. R. Carrignan, B. P. Block, J. C. Maurer, A. E. Hedin, C. A. Reber, N. W. Spencer The neutral mass spectrometer on Dynamics Explorer B Space Sci. Instrum., v. 5, n. 4, p. 429, 1981.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘de2’
name
‘nacs’
sat_id
None Supported
tag
None Supported

Authors

  1. Klenzing

DE2 RPA

Supports the Retarding Potential Analyzer (RPA) instrument on Dynamics Explorer 2 (DE2).

From CDAWeb:

The Retarding Potential Analyzer (RPA) measured the bulk ion velocity in the direction of the spacecraft motion, the constituent ion concentrations, and the ion temperature along the satellite path. These parameters were derived from a least squares fit to the ion number flux vs energy curve obtained by sweeping or stepping the voltage applied to the internal retarding grids of the RPA. In addition, a separate wide aperture sensor, a duct sensor, was flown to measure the spectral characteristics of iregularities in the total ion concentration. The measured parameters obtained from this investigation were important to the understanding of mechanisms that influence the plasma; i.e., to understand the coupling between the solar wind and the earth’s atmosphere. The measurements were made with a multigridded planar retarding potential analyzer very similar in concept and geometry to the instruments carried on the AE satellites. The retarding potential was variable in the range from approximately +32 to 0 V. The details of this voltage trace, and whether it was continuous or stepped, depended on the operating mode of the instrument. Specific parameters deduced from these measurements were ion temperature; vehicle potential; ram component of the ion drift velocity; the ion and electron concentration irregularity spectrum; and the concentration of H+, He+, O+, and Fe+, and of molecular ions near perigee.

It includes the DUCT portion of the high resolutiondata from the Dynamics Explorer 2 (DE-2) Retarding Potential Analyzer (RPA) for the whole DE-2 mission time period in ASCII format. This version was generated at NSSDC from the PI-provided binary data (SPIO-00232). The DUCT files include RPA measurements ofthe total ion concentration every 64 times per second. Due to a failure in the instrument memory system RPA data are not available from 81317 06:26:40 UT to 82057 13:16:00 UT. This data set is based on the revised version of the RPA files that was submitted by the PI team in June of 1995. The revised RPA data include a correction to the spacecraft potential.

References

W. B. Hanson, R. A. Heelis, R. A. Power, C. R. Lippincott, D. R. Zuccaro, B. J. Holt, L. H. Harmon, and S. Sanatani, “The retarding potential analyzer for dynamics explorer-B,” Space Sci. Instrum. 5, 503–510 (1981).

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘de2’
name
‘rpa’
sat_id
‘’
tag
None Supported

Authors

  1. Klenzing

DE2 WATS

Supports the Wind and Temperature Spectrometer (WATS) instrument on Dynamics Explorer 2 (DE2).

From CDAWeb:

The Wind and Temperature Spectrometer (WATS) measured the in situ neutral winds, the neutral particle temperatures, and the concentrations of selected gases. The objective of this investigation was to study the interrelationships among the winds, temperatures, plasma drift, electric fields, and other properties of the thermosphere that were measured by this and other instruments on the spacecraft. Knowledge of how these properties are interrelated contributed to an understanding of the consequences of the acceleration of neutral particles by the ions in the ionosphere, the acceleration of ions by neutrals creating electric fields, and the related energy transfer between the ionosphere and the magnetosphere. Three components of the wind, one normal to the satellite velocity vector in the horizontal plane, one vertical, and one in the satellite direction were measured. A retarding potential quadrupole mass spectrometer, coupled to the atmosphere through a precisely orificed antechamber, was used. It was operated in either of two modes: one employed the retarding capability and the other used the ion source as a conventional nonretarding source. Two scanning baffles were used in front of the mass spectrometer: one moved vertically and the other moved horizontally. The magnitudes of the horizontal and vertical components of the wind normal to the spacecraft velocity vector were computed from measurements of the angular relationship between the neutral particle stream and the sensor. The component of the total stream velocity in the satellite direction was measured directly by the spectrometer system through determination of the required retarding potential. At altitudes too high for neutral species measurements, the planned operation required the instrument to measure the thermal ion species only. A series of four sequentially occurring slots –each a 2-s long measurement interval– was adapted for the basic measurement format of the instrument. Different functions were commanded into these slots in any combination, one per measurement interval. Thus the time resolution can be 2, 4, 6, or 8 seconds. Further details are found in This data set consists of the high-resolution data of the Dynamics Explorer 2 Wind and Temperature Spectrometer (WATS) experiment. The files contain the neutral density, temperature and horizontal (zonal) wind velocity, and orbital parameters in ASCII format. The time resolution is typically 2 seconds. Data are given as daily files (typically a few 100 Kbytes each). PI-provided software (WATSCOR) was used to correct the binary data set. NSSDC-developed software was used to add the orbit parameters, to convert the binary into ASCII format and to combine the (PI-provided) orbital files into daily files. For more on DE-2, WATS, and the binary data, see the WATS_VOLDESC_SFDU_DE.DOC and WATS_FORMAT_SFDU_DE.DOC files. More information about the processing done at NSSDC is given in WATS_NSSDC_PRO_DE.DOC.

References

N. W. Spencer, L. E. Wharton, H. B. Niemann, A. E. Hedin, G. R. Carrignan, J. C. Maurer The Dynamics Explorer Wind and Temperature Spectrometer Space Sci. Instrum., v. 5, n. 4, p. 417, 1981.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘de2’
name
‘wats’
sat_id
None Supported
tag
None Supported

Authors

  1. Klenzing

Demeter IAP

Supports the Plasma Analyzer Instrument (Instrument Analyseur de Plasma, or IAP) onboard the Detection of Electro-Magnetic Emissions Transmitted from Earthquake Regions (DEMETER) Microsatellite.

The IAP consists of a Velocity Analyzer (ADV) and Retarding potential analyzer (APR) to provide plasma velocities, ion density and temperature, and satellite potential. The computation of the ion plasma parameters works well when there are at least two ions being considered. Also, the ADV requires currents of at least 1 nA to produce believable measurements. The IAP was run in both survey and burst mode.

Downloads data from the Plasma physics data center (Centre de donees de la physique des plasmas, CDPP), the French national data center for natural plasmas of the solar system. This data product requires registration and user initiated downloading after ordering a data product.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatIncubator (https://github.com/pysat/pysatIncubator)

Properties

platform
‘demeter’
name
‘iap’
tag
‘survey’ or ‘burst’
sat_id
None supported

Examples

import pysat
demeter = pysat.Instrument('demeter', 'iap', 'survey', clean_level='none')
demeter.load(2009, 363)

Custom Functions

add_drift_geo_coord
Calcuate the ion velocity in geographic coordinates
add_drift_lgm_coord
Calcuate the ion velocity in local geomagneic coordinates
add_drift_sat_coord
Calculate the ion velocity in satellite x, y, z coordinates
pysat.instruments.demeter_iap.add_drift_sat_coord(inst)

Calculate the ion velocity in satellite x,y,z coordinates

Deprecated since version 2.3.0: This routine has been deprecated in pysat 3.0.0, and will be accessible in pysatIncubator

Parameters:inst (pysat.Instrument) – DEMETER IAP instrument class object
Returns:
Return type:Adds data values iv_Ox, iv_Oy
pysat.instruments.demeter_iap.add_drift_lgm_coord(inst)

Calcuate the ion velocity in local geomagneic coordinates

Deprecated since version 2.3.0: This routine has been deprecated in pysat 3.0.0, and will be accessible in pysatIncubator

Parameters:inst (pysat.Instrument) – DEMETER IAP instrument class object
Returns:
  • Adds data values iv_par (parallel to B vector at satellite),
  • iv_pos (perpendictular to B, in the plane of the satellite),
  • iv_perp (completes the coordinate system). If iv_Ox and iv_Oy
  • do not exist yet, adds them as well
pysat.instruments.demeter_iap.add_drift_geo_coord(inst)

Calcuate the ion velocity in geographic coordinates

Deprecated since version 2.3.0: This routine has been deprecated in pysat 3.0.0, and will be accessible in pysatIncubator

Parameters:inst (pysat.Instrument) – DEMETER IAP instrument class object
Returns:
  • Adds data values iv_geo_x (towards the intersection of equator and
  • Grennwich meridian), iv_geo_y (completes coordinate system),
  • iv_geo_z (follows Earth’s rotational axis, positive Northward).
  • If iv_Ox,y do not exist yet, adds them as well

DMSP IVM

Supports the Ion Velocity Meter (IVM) onboard the Defense Meteorological Satellite Program (DMSP).

The IVM is comprised of the Retarding Potential Analyzer (RPA) and Drift Meter (DM). The RPA measures the energy of plasma along the direction of satellite motion. By fitting these measurements to a theoretical description of plasma the number density, plasma composition, plasma temperature, and plasma motion may be determined. The DM directly measures the arrival angle of plasma. Using the reported motion of the satellite the angle is converted into ion motion along two orthogonal directions, perpendicular to the satellite track.

Downloads data from the National Science Foundation Madrigal Database. The routine is configured to utilize data files with instrument performance flags generated at the Center for Space Sciences at the University of Texas at Dallas.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatMadrigal (https://github.com/pysat/pysatMadrigal)

Properties

platform
‘dmsp’
name
‘ivm’
tag
‘utd’, None
sat_id
[‘f11’, ‘f12’, ‘f13’, ‘f14’, ‘f15’, ‘f16’, ‘f17’, ‘f18’]

Examples

import pysat
dmsp = pysat.Instrument('dmsp', 'ivm', 'utd', 'f15', clean_level='clean')
dmsp.download(pysat.datetime(2017, 12, 30), pysat.datetime(2017, 12, 31),
              user='Firstname+Lastname', password='email@address.com')
dmsp.load(2017, 363)

Note

Please provide name and email when downloading data with this routine.

Code development supported by NSF grant 1259508

Custom Functions

add_drift_unit_vectors
Add unit vectors for the satellite velocity
add_drifts_polar_cap_x_y
Add polar cap drifts in cartesian coordinates
smooth_ram_drifts
Smooth the ram drifts using a rolling mean
update_DMSP_ephemeris
Updates DMSP instrument data with DMSP ephemeris
pysat.instruments.dmsp_ivm.smooth_ram_drifts(inst, rpa_flag_key=None, rpa_vel_key='ion_v_sat_for')

Smooth the ram drifts using a rolling mean

Deprecated since version 2.3.0: This routine has been deprecated in pysat 3.0.0, and will be accessible in pysatMadrigal.instruments.methods.dmsp.smooth_ram_drifts

Parameters:
  • rpa_flag_key (string or NoneType) – RPA flag key, if None will not select any data. The UTD RPA flag key is ‘rpa_flag_ut’ (default=None)
  • rpa_vel_key (string) – RPA velocity data key (default=’ion_v_sat_for’)
Returns:

Return type:

RPA data in instrument object

pysat.instruments.dmsp_ivm.update_DMSP_ephemeris(inst, ephem=None)

Updates DMSP instrument data with DMSP ephemeris

Deprecated since version 2.3.0: This routine has been deprecated in pysat 3.0.0, and will be accessible in pysatMadrigal.instruments.methods.dmsp.update_DMSP_ephemeris

Parameters:ephem (pysat.Instrument or NoneType) – dmsp_ivm_ephem instrument object
Returns:
Return type:Updates ‘mlt’ and ‘mlat’
pysat.instruments.dmsp_ivm.add_drift_unit_vectors(inst)

Add unit vectors for the satellite velocity

Deprecated since version 2.3.0: This routine has been deprecated in pysat 3.0.0, and will be accessible in pysatMadrigal.instruments.methods.dmsp.add_drift_unit_vectors

Returns:
  • Adds unit vectors in cartesian and polar coordinates for RAM and
  • cross-track directions
    • ‘unit_ram_x’, ‘unit_ram_y’, ‘unit_ram_r’, ‘unit_ram_theta’
    • ’unit_cross_x’, ‘unit_cross_y’, ‘unit_cross_r’, ‘unit_cross_theta’

Notes

Assumes that the RAM vector is pointed perfectly forward

pysat.instruments.dmsp_ivm.add_drifts_polar_cap_x_y(inst, rpa_flag_key=None, rpa_vel_key='ion_v_sat_for', cross_vel_key='ion_v_sat_left')

Add polar cap drifts in cartesian coordinates

Deprecated since version 2.3.0: This routine has been deprecated in pysat 3.0.0, and will be accessible in pysatMadrigal.instruments.methods.dmsp.add_drifts_polar_cap_x_y

Parameters:
  • rpa_flag_key (string or NoneType) – RPA flag key, if None will not select any data. The UTD RPA flag key is ‘rpa_flag_ut’ (default=None)
  • rpa_vel_key (string) – RPA velocity data key (default=’ion_v_sat_for’)
  • cross_vel_key (string) – Cross-track velocity data key (default=’ion_v_sat_left’)
Returns:

  • Adds ‘ion_vel_pc_x’, ‘ion_vel_pc_y’, and ‘partial’. The last data key
  • indicates whether RPA data was available (False) or not (True).

Notes

Polar cap drifts assume there is no vertical component to the X-Y velocities

ICON EUV

Supports the Extreme Ultraviolet (EUV) imager onboard the Ionospheric CONnection Explorer (ICON) satellite. Accesses local data in netCDF format.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA). Note that the ICON files are retrieved from different servers here and in pysatNASA, resulting in a difference in local file names. Please see the migration guide there for more details.

Properties

platform
‘icon’
name
‘euv’
tag
None supported

Warning

  • The cleaning parameters for the instrument are still under development.
  • Only supports level-2 data.

Examples

import pysat
euv = pysat.Instrument(platform='icon', name='euv')
euv.download(dt.datetime(2020, 1, 1), dt.datetime(2020, 1, 31))
euv.load(2020, 1)

By default, pysat removes the ICON level tags from variable names, ie, ICON_L27_Ion_Density becomes Ion_Density. To retain the original names, use

euv = pysat.Instrument(platform='icon', name='euv',
                       keep_original_names=True)

Authors

Jeff Klenzing, Mar 17, 2018, Goddard Space Flight Center Russell Stoneback, Mar 23, 2018, University of Texas at Dallas

ICON FUV

Supports the Far Ultraviolet (FUV) imager onboard the Ionospheric CONnection Explorer (ICON) satellite. Accesses local data in netCDF format.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA). Note that the ICON files are retrieved from different servers here and in pysatNASA, resulting in a difference in local file names. Please see the migration guide there for more details.

Properties

platform
‘icon’
name
‘fuv’
tag
None supported

Warning

  • The cleaning parameters for the instrument are still under development.
  • Only supports level-2 data.

Example

import pysat
fuv = pysat.Instrument(platform='icon', name='fuv', tag='day')
fuv.download(dt.datetime(2020, 1, 1), dt.datetime(2020, 1, 31))
fuv.load(2020, 1)

By default, pysat removes the ICON level tags from variable names, ie, ICON_L27_Ion_Density becomes Ion_Density. To retain the original names, use

fuv = pysat.Instrument(platform='icon', name='fuv', tag=day',
                       keep_original_names=True)

Authors

Originated from EUV support. Jeff Klenzing, Mar 17, 2018, Goddard Space Flight Center Russell Stoneback, Mar 23, 2018, University of Texas at Dallas Conversion to FUV, Oct 8th, 2028, University of Texas at Dallas

ICON IVM

Supports the Ion Velocity Meter (IVM) onboard the Ionospheric Connections (ICON) Explorer.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA). Note that the ICON files are retrieved from different servers here and in pysatNASA, resulting in a difference in local file names. Please see the migration guide there for more details.

Properties

platform
‘icon’
name
‘ivm’
tag
None supported
sat_id
‘a’ or ‘b’

Warning

  • No download routine as ICON has not yet been launched
  • Data not yet publicly available

Example

import pysat
ivm = pysat.Instrument(platform='icon', name='ivm', sat_id='a')
ivm.download(dt.datetime(2020, 1, 1), dt.datetime(2020, 1, 31))
ivm.load(2020, 1)

By default, pysat removes the ICON level tags from variable names, ie, ICON_L27_Ion_Density becomes Ion_Density. To retain the original names, use

ivm = pysat.Instrument(platform='icon', name='ivm', sat_id='a',
                       keep_original_names=True)

Author

    1. Stoneback

ICON MIGHTI

Supports the Michelson Interferometer for Global High-resolution Thermospheric Imaging (MIGHTI) instrument onboard the Ionospheric CONnection Explorer (ICON) satellite. Accesses local data in netCDF format.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA). Note that the ICON files are retrieved from different servers here and in pysatNASA, resulting in a difference in local file names. Please see the migration guide there for more details.

Properties

platform
‘icon’
name
‘mighti’
tag
Supports ‘los_wind_green’, ‘los_wind_red’, ‘vector_wind_green’, ‘vector_wind_red’, ‘temperature’. Note that not every data product available for every sat_id
sat_id
‘’, ‘a’, or ‘b’

Warning

  • The cleaning parameters for the instrument are still under development.
  • Only supports level-2 data.

Example

import pysat
mighti = pysat.Instrument('icon', 'mighti', 'vector_wind_green',
                          clean_level='clean')
mighti.download(dt.datetime(2020, 1, 30), dt.datetime(2020, 1, 31))
mighti.load(2020, 2)

By default, pysat removes the ICON level tags from variable names, ie, ICON_L27_Ion_Density becomes Ion_Density. To retain the original names, use

mighti = pysat.Instrument(platform='icon', name='mighti',
                          tag='vector_wind_green', clean_level='clean',
                          keep_original_names=True)

Authors

Originated from EUV support. Jeff Klenzing, Mar 17, 2018, Goddard Space Flight Center Russell Stoneback, Mar 23, 2018, University of Texas at Dallas Conversion to MIGHTI, Oct 8th, 2028, University of Texas at Dallas

ISS-FPMU

Supports the Floating Potential Measurement Unit (FPMU) instrument onboard the International Space Station (ISS). Downloads data from the NASA Coordinated Data Analysis Web (CDAWeb).

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘iss’
name
‘fpmu’
tag
None Supported
sat_id
None supported

Warning

  • Currently clean only replaces fill values with Nans.
  • Module not written by FPMU team.

JRO ISR

Supports the Incoherent Scatter Radar at the Jicamarca Radio Observatory

The Incoherent Scatter Radar (ISR) at the Jicamarca Radio Observatory (JRO) observes ion drifts, line-of-sight neutral winds, electron density and temperature, ion temperature, and ion composition through three overarching experiments.

Downloads data from the JRO Madrigal Database.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatMadrigal (https://github.com/pysat/pysatMadrigal)

Properties

platform
‘jro’
name
‘isr’
tag
‘drifts’, ‘drifts_ave’, ‘oblique_stan’, ‘oblique_rand’, ‘oblique_long’

Examples

import pysat
jro = pysat.Instrument('jro', 'isr', 'drifts', clean_level='clean')
jro.download(pysat.datetime(2017, 12, 30), pysat.datetime(2017, 12, 31),
             user='Firstname+Lastname', password='email@address.com')
jro.load(2017, 363)

Note

Please provide name and email when downloading data with this routine.

OMNI_HRO

Supports OMNI Combined, Definitive, IMF and Plasma Data, and Energetic Proton Fluxes, Time-Shifted to the Nose of the Earth’s Bow Shock, plus Solar and Magnetic Indices. Downloads data from the NASA Coordinated Data Analysis Web (CDAWeb). Supports both 5 and 1 minute files.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘omni’
name
‘hro’
tag
Select time between samples, one of {‘1min’, ‘5min’}
sat_id
None supported

Note

Files are stored by the first day of each month. When downloading use omni.download(start, stop, freq=’MS’) to only download days that could possibly have data. ‘MS’ gives a monthly start frequency.

This material is based upon work supported by the National Science Foundation under Grant Number 1259508.

Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

Warning

  • Currently no cleaning routine. Though the CDAWEB description indicates that these level-2 products are expected to be ok.
  • Module not written by OMNI team.

Custom Functions

time_shift_to_magnetic_poles
Shift time from bowshock to intersection with one of the magnetic poles
calculate_clock_angle
Calculate the clock angle and IMF mag in the YZ plane
calculate_imf_steadiness
Calculate the IMF steadiness using clock angle and magnitude in the YZ plane
calculate_dayside_reconnection
Calculate the dayside reconnection rate
pysat.instruments.omni_hro.calculate_clock_angle(inst)

Calculate IMF clock angle and magnitude of IMF in GSM Y-Z plane

Deprecated since version 2.3.0: This function has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Parameters:inst (pysat.Instrument) – Instrument with OMNI HRO data
pysat.instruments.omni_hro.calculate_imf_steadiness(inst, steady_window=15, min_window_frac=0.75, max_clock_angle_std=28.64788975654116, max_bmag_cv=0.5)

Calculate IMF steadiness using clock angle standard deviation and the coefficient of variation of the IMF magnitude in the GSM Y-Z plane

Deprecated since version 2.3.0: This function has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Parameters:
  • inst (pysat.Instrument) – Instrument with OMNI HRO data
  • steady_window (int) – Window for calculating running statistical moments in min (default=15)
  • min_window_frac (float) – Minimum fraction of points in a window for steadiness to be calculated (default=0.75)
  • max_clock_angle_std (float) – Maximum standard deviation of the clock angle in degrees (default=22.5)
  • max_bmag_cv (float) – Maximum coefficient of variation of the IMF magnitude in the GSM Y-Z plane (default=0.5)
pysat.instruments.omni_hro.time_shift_to_magnetic_poles(inst)

OMNI data is time-shifted to bow shock. Time shifted again to intersections with magnetic pole.

Deprecated since version 2.3.0: This function has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Parameters:inst (Instrument class object) – Instrument with OMNI HRO data

Notes

Time shift calculated using distance to bow shock nose (BSN) and velocity of solar wind along x-direction.

Warning

Use at own risk.

ROCSAT-1 IVM

Supports the Ion Velocity Meter (IVM) onboard the Republic of China Satellite (ROCSAT-1). Downloads data from the NASA Coordinated Data Analysis Web (CDAWeb).

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘rocsat1’
name
‘ivm’
tag
None
sat_id
None supported

Note

  • no tag or sat_id required

Warning

  • Currently no cleaning routine.

SPORT IVM

Ion Velocity Meter (IVM) support for the NASA/INPE SPORT CubeSat.

This mission is still in development. This routine is here to help with the development of code associated with SPORT and the IVM.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

SuperDARN

SuperDARN data support for grdex files(Alpha Level!)

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatIncubator (https://github.com/pysat/pysatIncubator)

Properties

platform
‘superdarn’
name
‘grdex’
tag
‘north’ or ‘south’ for Northern/Southern hemisphere data

Note

Requires davitpy and davitpy to load SuperDARN files. Uses environment variables set by davitpy to download files from Virginia Tech SuperDARN data servers. davitpy routines are used to load SuperDARN data.

This material is based upon work supported by the National Science Foundation under Grant Number 1259508.

Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

Warning

Cleaning only removes entries that have 0 vectors, grdex files are constituted from what it is thought to be good data.

SuperMAG

Supports SuperMAG ground magnetometer measurements and SML/SMU indices. Downloading is supported; please follow their rules of the road: http://supermag.jhuapl.edu/info/?page=rulesoftheroad

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatIncubator (https://github.com/pysat/pysatIncubator)

Properties

platform
‘supermag’
name
‘magnetometer’
tag
Select {‘indices’, ‘’, ‘all’, ‘stations’}

Note

Files must be downloaded from the website, and is freely available after registration.

This material is based upon work supported by the National Science Foundation under Grant Number 1259508.

Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

Warning

  • Currently no cleaning routine, though the SuperMAG description indicates that these products are expected to be good. More information about the processing is available
  • Module not written by the SuperMAG team.

SW Dst

Supports Dst values. Downloads data from NGDC.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatSpaceWeather (https://github.com/pysat/pysatSpaceWeather)

Properties

platform
‘sw’
name
‘dst’
tag
None supported

Note

Will only work until 2057.

Download method should be invoked on a yearly frequency, dst.download(date1, date2, freq=’AS’)

This material is based upon work supported by the National Science Foundation under Grant Number 1259508.

Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

SW F107

Supports F10.7 index values. Downloads data from LASP and the SWPC.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatSpaceWeather (https://github.com/pysat/pysatSpaceWeather)

Properties

platform
‘sw’
name
‘f107’
tag
  • ‘’ : LASP F10.7 data (downloads by month, loads by day)
  • ‘all’ : All LASP standard F10.7
  • ‘prelim’ : Preliminary SWPC daily solar indices
  • ‘daily’ : Daily SWPC solar indices (contains last 30 days)
  • ‘forecast’ : Grab forecast data from SWPC (next 3 days)
  • ‘45day’ : 45-Day Forecast data from the Air Force

Note

The forecast data is stored by generation date, where each file contains the forecast for the next three days. Forecast data downloads are only supported for the current day. When loading forecast data, the date specified with the load command is the date the forecast was generated. The data loaded will span three days. To always ensure you are loading the most recent data, load the data with tomorrow’s date.

f107 = pysat.Instrument('sw', 'f107', tag='forecast')
f107.download()
f107.load(date=f107.tomorrow())

The forecast or prelim data should not be used with the data padding option available from pysat.Instrument objects. The ‘all’ tag shouldn’t be used either, no other data available to pad with.

Warning

The ‘forecast’ F10.7 data loads three days at a time. The data padding feature and multi_file_day feature available from the pyast.Instrument object is not appropriate for ‘forecast’ data.

SW Kp

Supports Kp index values. Downloads data from ftp.gfz-potsdam.de or SWPC.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatSpaceWeather (https://github.com/pysat/pysatSpaceWeather)

param platform:

‘sw’

param name:

‘kp’

param tag:
  • ‘’ : Standard Kp data
  • ‘forecast’ : Grab forecast data from SWPC (next 3 days)
  • ‘recent’ : Grab last 30 days of Kp data from SWPC

Note

Standard Kp files are stored by the first day of each month. When downloading use kp.download(start, stop, freq=’MS’) to only download days that could possibly have data. ‘MS’ gives a monthly start frequency.

The forecast data is stored by generation date, where each file contains the forecast for the next three days. Forecast data downloads are only supported for the current day. When loading forecast data, the date specified with the load command is the date the forecast was generated. The data loaded will span three days. To always ensure you are loading the most recent data, load the data with tomorrow’s date.

kp = pysat.Instrument('sw', 'kp', tag='recent')
kp.download()
kp.load(date=kp.tomorrow())

Recent data is also stored by the generation date from the SWPC. Each file contains 30 days of Kp measurements. The load date issued to pysat corresponds to the generation date.

The recent and forecast data should not be used with the data padding option available from pysat.Instrument objects.

Warning

The ‘forecast’ Kp data loads three days at a time. The data padding feature and multi_file_day feature available from the pyast.Instrument object is not appropriate for Kp ‘forecast’ data.

This material is based upon work supported by the National Science Foundation under Grant Number 1259508.

Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

Custom Functions

filter_geoquiet
Filters pysat.Instrument data for given time after Kp drops below gate.
pysat.instruments.sw_kp.filter_geoquiet(sat, maxKp=None, filterTime=None, kpData=None, kp_inst=None)

Filters pysat.Instrument data for given time after Kp drops below gate.

Deprecated since version 2.3.0: This routine has been deprecated in pysat 3.0.0, and has been replaced with the more adaptable function, pysatSpaceWeather.instruments.methods.kp_ap.filter_geomag. Be sure to update to use the new kwargs.

Parameters:
  • sat (pysat.Instrument) – Instrument to be filtered
  • maxKp (float) – Maximum Kp value allowed. Kp values above this trigger sat.data filtering.
  • filterTime (int) – Number of hours to filter data after Kp drops below maxKp
  • kpData (pysat.Instrument (optional)) – Kp pysat.Instrument object with data already loaded
  • kp_inst (pysat.Instrument (optional)) – Kp pysat.Instrument object ready to load Kp data.Overrides kpData.

Notes

Loads Kp data for the same timeframe covered by sat and sets sat.data to NaN for times when Kp > maxKp and for filterTime after Kp drops below maxKp.

This routine is written for standard Kp data, not the forecast or recent data.

TIMED/SABER

Supports the Sounding of the Atmosphere using Broadband Emission Radiometry (SABER) instrument on the Thermosphere Ionosphere Mesosphere Energetics Dynamics (TIMED) satellite.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘timed’
name
‘saber’
tag
None supported
sat_id
None supported

Note

SABER “Rules of the Road” for DATA USE Users of SABER data are asked to respect the following guidelines

  • Mission scientific and model results are open to all.
  • Guest investigators, and other members of the scientific community or general public should contact the PI or designated team member early in an analysis project to discuss the appropriate use of the data.
  • Users that wish to publish the results derived from SABER data should normally offer co-authorship to the PI, Associate PI or designated team members. Co-authorship may be declined. Appropriate acknowledgement of institutions, personnel, and funding agencies should be given.
  • Users should heed the caveats of SABER team members as to the interpretation and limitations of the data. SABER team members may insist that such caveats be published, even if co-authorship is declined. Data and model version numbers should also be specified.
  • Pre-prints of publications and conference abstracts should be widely distributed to interested parties within the mission and related projects.

Warning

Authors

  1. Klenzing, 4 March 2019

TIMED/SEE

Supports the SEE instrument on TIMED.

Downloads data from the NASA Coordinated Data Analysis Web (CDAWeb).

Supports two options for loading that may be specified at instantiation.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatNASA (https://github.com/pysat/pysatNASA)

Properties

platform
‘timed’
name
‘see’
tag
None
sat_id
None supported
flatten_twod
If True, then two dimensional data is flattened across columns. Name mangling is used to group data, first column is ‘name’, last column is ‘name_end’. In between numbers are appended ‘name_1’, ‘name_2’, etc. All data for a given 2D array may be accessed via, data.loc[:, ‘item’:’item_end’] If False, then 2D data is stored as a series of DataFrames, indexed by Epoch. data.loc[0, ‘item’] (default=True)

Note

  • no tag required

Warning

  • Currently no cleaning routine.

UCAR TIEGCM

Supports loading data from files generated using TIEGCM (Thermosphere Ionosphere Electrodynamics General Circulation Model) model. TIEGCM file is a netCDF file with multiple dimensions for some variables.

Deprecated since version 2.3.0: This Instrument module has been removed from pysat in the 3.0.0 release and can now be found in pysatModels (https://github.com/pysat/pysatModels)

Properties

platform
‘ucar’
name
‘tiegcm’
tag
None supported
sat_id
None supported