Supported Instruments

ACE EPAM

Module for the Advanced Composition Explorer (ACE) EPAM instrument.

Properties

platform: ‘ace’
name: ‘epam_l2’
tag: ‘base’ or ‘key’
inst_id: ’12sec’, ‘5min’, ‘1hr’

References

Stone, E., Frandsen, A., Mewaldt, R. et al. The Advanced Composition Explorer. Space Science Reviews 86, 1–22 (1998). https://doi.org/10.1023/A:1005082526237
Gold, R., Krimigis, S., Hawkins, S. et al. Electron, Proton, and Alpha Monitor on the Advanced Composition Explorer spacecraft. Space Science Reviews 86, 541–562 (1998). https://doi.org/10.1023/A:1005088115759

Note

Level 1 ACE data is maintained at pysatSpaceWeather.
Release notes at https://cdaweb.gsfc.nasa.gov/pub/data/ace/epam/epam_level2_release_notes.txt

Warnings

The cleaning parameters for the instrument are still under development.

ACE MAG

Module for the Advanced Composition Explorer (ACE) MAG instrument.

Properties

platform: ‘ace’
name: ‘mag_l2’
tag: ‘base’ or ‘key’
inst_id: ‘1sec’, ’16sec’, ‘4min’, ‘5min’, ‘1hr’

References

Stone, E., Frandsen, A., Mewaldt, R. et al. The Advanced Composition Explorer. Space Science Reviews 86, 1–22 (1998). https://doi.org/10.1023/A:1005082526237
Smith, C., L’Heureux, J., Ness, N. et al. The ACE Magnetic Fields Experiment. Space Science Reviews 86, 613–632 (1998). https://doi.org/10.1023/A:1005092216668

Note

Level 1 ACE data is maintained at pysatSpaceWeather.
Release notes at https://cdaweb.gsfc.nasa.gov/pub/data/ace/mag/mag_level2_release_notes.txt

Warnings

The cleaning parameters for the instrument are still under development.

pysatNASA.instruments.ace_mag_l2.preprocess(self)[source]: Adjust dimensionality of metadata.

ACE SIS

Module for the Advanced Composition Explorer (ACE) SIS instrument.

Properties

platform: ‘ace’
name: ‘sis_l2’
tag: ‘base’ or ‘key’
inst_id: ‘256sec’ or ‘1hr’

References

Stone, E., Frandsen, A., Mewaldt, R. et al. The Advanced Composition Explorer. Space Science Reviews 86, 1–22 (1998). https://doi.org/10.1023/A:1005082526237
Stone, E., Cohen, C., Cook, W. et al. The Solar Isotope Spectrometer for the Advanced Composition Explorer. Space Science Reviews 86, 357–408 (1998). https://doi.org/10.1023/A:1005027929871

Note

Level 1 ACE data is maintained at pysatSpaceWeather.

Warnings

The cleaning parameters for the instrument are still under development.

ACE SWEPAM

Module for the Advanced Composition Explorer (ACE) EPAM instrument.

Properties

platform: ‘ace’
name: ‘swepam_l2’
tag: ‘base’ or ‘key’
inst_id: ’64sec’, ‘5min’, ‘1hr’

References

Stone, E., Frandsen, A., Mewaldt, R. et al. The Advanced Composition Explorer. Space Science Reviews 86, 1–22 (1998). https://doi.org/10.1023/A:1005082526237
McComas, D., Bame, S., Barker, P. et al. Solar Wind Electron Proton Alpha Monitor (SWEPAM) for the Advanced Composition Explorer. Space Science Reviews 86, 563–612 (1998). https://doi.org/10.1023/A:1005040232597

Note

Level 1 ACE data is maintained at pysatSpaceWeather.
Release notes at https://cdaweb.gsfc.nasa.gov/pub/data/ace/swepam/swepam_level2_release_notes.txt

Warnings

The cleaning parameters for the instrument are still under development.

C/NOFS IVM

Module for the C/NOFS IVM instrument.

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.

Properties

platform: ‘cnofs’
name: ‘ivm’
tag: None supported
inst_id: None supported

Warnings

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.

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.

pysatNASA.instruments.cnofs_ivm.clean(self)[source]: Clean C/NOFS IVM data to the specified level.

pysatNASA.instruments.cnofs_ivm.preprocess(self)[source]: Apply C/NOFS IVM default attributes.

C/NOFS PLP

Module for the C/NOFS PLP instrument.

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.

Properties

platform: ‘cnofs’
name: ‘plp’
tag: None supported
inst_id: None supported

Warnings

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

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.

C/NOFS VEFI

Module for the C/NOFS VEFI instrument.

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 (with updated link):

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, https://geomag.us/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.

Properties

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

Note

tag = ‘dc_b’: 1 second DC magnetometer data

Warnings

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

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.

pysatNASA.instruments.cnofs_vefi.clean(self)[source]: Clean VEFI data to the specified level.

DE2 FPI

The DE2 FPI instrument.

Supports the Fabry-Perot Interferometer (FPI) instrument on Dynamics Explorer 2 (DE2).

From CDAWeb:

The Fabry-Perot Interferometer (FPI) was a high-resolution remote sensing instrument designed to measure the thermospheric temperature, meridional wind, and density of the following metastable atoms: atomic oxygen (singlet S and D) and the 2P state of ionic atomic oxygen. The FPI performed a wavelength analysis on the light detected from the thermospheric emission features by spatially scanning the interference fringe plane with a multichannel array detector. The wavelength analysis characterized the Doppler line profile of the emitting species. A sequential altitude scan performed by a commandable horizon scan mirror provided a cross-sectional view of the thermodynamic and dynamic state of the thermosphere below the DE 2 orbit. The information obtained from this investigation was used to study the dynamic response of the thermosphere to the energy sources caused by magnetospheric electric fields and the absorption of solar ultraviolet light in the thermosphere. The instrument was based on the visible airglow experiment (VAE) used in the AE program. The addition of a scanning mirror, the Fabry-Perot etalon, an image plane detector, and a calibration lamp were the principal differences. Interference filters isolated lines at (in Angstroms) 5577, 6300, 7320, 5896, and 5200. The FPI had a field of view of 0.53 deg (half-cone angle). More details are found in P. B. Hays et al., Space Sci. Instrum., v. 5, n. 4, p. 395, 1981. From February 16, 1982 to September 11, 1982 the DE satellite was inverted and the FPI measured galactic emissions.

Properties

platform: ‘de2’
name: ‘fpi’
tag: None Supported
inst_id: None Supported

Warnings

Currently no cleaning routine.

References

Hays, P B, Killeen, T L, and Kennedy, B C. “Fabry-Perot interferometer on Dynamics Explorer”. Space Sci. Instrum., 5, 395-416, 1981.

DE2 LANG

Module for the DE2 LANG instrument.

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.

Properties

platform: ‘de2’
name: ‘lang’
tag: None Supported
inst_id: None Supported

Warnings

Currently no cleaning routine.

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., 5, 493-502, 1981.

DE2 NACS

The DE2 NACS instrument.

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.

Properties

platform: ‘de2’
name: ‘nacs’
tag: None Supported
inst_id: None Supported

Warnings

Currently no cleaning routine.

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., 5, 429-441, 1981.

DE2 RPA

Module for the DE2 RPA instrument.

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.

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.

Properties

platform: ‘de2’
name: ‘rpa’
tag: None Supported
inst_id: None Supported

Warnings

Currently no cleaning routine.

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).

DE2 VEFI

Module for the DE2 VEFI instrument.

Deprecated since version 0.0.6: The ‘’ tag is deprecated. This data set is replaced by the de2_vefimagb instrument. The ‘’ tag will be removed in 0.1.0+ to reduce redundancy.

From CDAWeb (adpated): This directory gathers data for the VEFI instrument that flew on the DE 2 spacecraft which was launched on 3 August 1981 into an elliptical orbit with an altitude range of 300 km to 1000 km and re-entered the atmosphere on 19 February 1983.

dca (NSSDC ID: 81-070B-02C)

This data set contains the averaged (2 samples per second) DC electric fields in spacecraft coordinates and orbit information in ASCII format.

ac (NSSDC ID: 81-070B-02E)

This data set contains the averaged AC electric field data (1 or 2 points per second) and orbit information.

References

Maynard, N. C., E. A. Bielecki, H. G. Burdick, Instrumentation for vector electric field measurements from DE-B, Space Sci. Instrum., 5, 523, 1981.

Properties

platform: ‘de2’
name: ‘vefi’
tag: ‘’, ‘dca’, ‘ac’
inst_id: none supported

Warnings

Currently no cleaning routine.

pysatNASA.instruments.de2_vefi.init(self)[source]: Initialize the Instrument object with instrument specific values.

pysatNASA.instruments.de2_vefi.load(fnames, tag='', inst_id='', **kwargs)[source]

Load DE2 VEFI data.

This routine is called as needed by pysat. It is not intended for direct user interaction.

Parameters:

fnamesarray-like: Iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.
tagstr: Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
inst_idstr: Instrument ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)

Returns:

datapds.DataFrame: A pandas DataFrame with data prepared for the pysat.Instrument.
metapysat.Meta: Metadata formatted for a pysat.Instrument object.

DE2 VEFIMAGB

Module for the DE2 VEFI instrument.

From CDAWeb (adpated): This directory gathers data for the VEFI and Magnetometer instruments that flew on the DE 2 spacecraft which was launched on 3 August 1981 into an elliptical orbit with an altitude range of 300 km to 1000 km and re-entered the atmosphere on 19 February 1983.

References

Maynard, N. C., E. A. Bielecki, H. G. Burdick, Instrumentation for vector electric field measurements from DE-B, Space Sci. Instrum., 5, 523, 1981.

Properties

platform: ‘de2’
name: ‘vefimagb’
tag: ‘e’, ‘b’
inst_id: none supported

Note

Electric and Magnetic fields have the same cadence, but different time indices. Currently loads one index per instrument. Files kept in the same directory to prevent duplication of downloads.

Examples

import datetime as dt
import pysat

# Set electric field instrument
vefi = pysat.Instrument(platform='de2', name='vefimagb', tag='e')
vefi.download(dt.datetime(1983, 1, 1))

# Set magnetic field instrument
mag = pysat.Instrument(platform='de2', name='vefimagb', tag='b')

# Both instruments can be loaded from the same download
vefi.load(1983, 1)
mag.load(1983, 1)

pysatNASA.instruments.de2_vefimagb.load(fnames, tag='', inst_id='', **kwargs)[source]

Load DE2 VEFI data.

This routine is called as needed by pysat. It is not intended for direct user interaction.

Parameters:

fnamesarray-like: Iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.
tagstr: Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
inst_idstr: Instrument ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
kwargsdict: Additional kwargs that may be supplied to the instrument during the course of unit tests. Not implemented for this instrument.

Returns:

datapds.DataFrame: A pandas DataFrame with data prepared for the pysat.Instrument.
metapysat.Meta: Metadata formatted for a pysat.Instrument object.

DE2 WATS

Module for the DE2 WATS instrument.

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.

Properties

platform: ‘de2’
name: ‘wats’
tag: None Supported
inst_id: None Supported

Warnings

Currently no cleaning routine.

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., 5, 417-428, 1981.

DMSP SSUSI

Module for the DMSP SSUSI instrument.

Supports the Special Sensor Ultraviolet Spectrographic Imager (SSUSI) instrument on Defense Meteorological Satellite Program (DMSP).

From JHU APL:

SSUSI was designed for the DMSP Block 5D-3 satellites. These satellites are placed into nearly polar, sun-synchronous orbits at an altitude of about 850 km. SSUSI is a remote-sensing instrument which measures ultraviolet (UV) emissions in five different wavelength bands from the Earth’s upper atmosphere. SSUSI is mounted on a nadir-looking panel of the satellite. The multicolor images from SSUSI cover the visible Earth disk from horizon to horizon and the anti-sunward limb up to an altitude of approximately 520 km.

The UV images and the derived environmental data provide the Air Force Weather Agency (Offutt Air Force Base, Bellevue, NE) with near real-time information that can be utilized in a number of applications, such as maintenance of high frequency (HF) communication links and related systems and assessment of the environmental hazard to astronauts on the Space Station.

Properties

platform: ‘dmsp’
name: ‘ssusi’
tag: ‘edr-aurora’ ‘sdr-disk’ ‘sdr2-disk’
inst_id: ‘f16’, ‘f17’, ‘f18’, ‘f19’

Warnings

Currently no cleaning routine.

References

Larry J. Paxton, Daniel Morrison, Yongliang Zhang, Hyosub Kil, Brian Wolven, Bernard S. Ogorzalek, David C. Humm, and Ching-I. Meng “Validation of remote sensing products produced by the Special Sensor Ultraviolet Scanning Imager (SSUSI): a far UV-imaging spectrograph on DMSP F-16”, Proc. SPIE 4485, Optical Spectroscopic Techniques, Remote Sensing, and Instrumentation for Atmospheric and Space Research IV, (30 January 2002); doi:10.1117/12.454268

pysatNASA.instruments.dmsp_ssusi.clean(self)[source]: Clean DMSP SSUSI imaging data.

pysatNASA.instruments.dmsp_ssusi.load(fnames, tag='', inst_id='', combine_times=False)[source]

Load DMSP SSUSI data into xarray.DataSet and pysat.Meta objects.

This routine is called as needed by pysat. It is not intended for direct user interaction.

Parameters:

fnamesarray-like: Iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.
tagstr: Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself.
inst_idstr: Satellite ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself.
combine_timesbool: For SDR data, optionally combine the different datetime coordinates into a single time coordinate (default=False)

Returns:

dataxr.DataSet: A xarray DataSet with data prepared for the pysat.Instrument
metapysat.Meta: Metadata formatted for a pysat.Instrument object.

Raises:

ValueError: If temporal dimensions are not consistent

Examples

inst = pysat.Instrument('dmsp', 'ssusi', tag='sdr-disk', inst_id='f16')
inst.load(2015, 1)

FORMOSAT-1 IVM

Module for the Formosat-1 IVM instrument.

Supports the Ion Velocity Meter (IVM) onboard the Formosat-1 (formerly ROCSAT-1) mission. Downloads data from the NASA Coordinated Data Analysis Web (CDAWeb).

Properties

platform: ‘formosat1’
name: ‘ivm’
tag: None
inst_id: None supported

Warnings

Currently no cleaning routine.

ICON EUV

Module for the ICON EUV instrument.

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

Properties

platform: ‘icon’
name: ‘euv’
tag: None supported
inst_id: None Supported

Warnings

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)

pysatNASA.instruments.icon_euv.clean(self)[source]: Clean ICON EUV data to the specified level.

pysatNASA.instruments.icon_euv.filter_metadata(meta_dict)[source]

Filter EUV metadata to remove warnings during loading.

Parameters:

meta_dictdict: Dictionary of metadata from file

Returns:

meta_dictdict: Filtered EUV metadata

pysatNASA.instruments.icon_euv.load(fnames, tag='', inst_id='', keep_original_names=False)[source]

Load ICON EUV data into xarray.Dataset object and pysat.Meta objects.

This routine is called as needed by pysat. It is not intended for direct user interaction.

Parameters:

fnamesarray-like: Iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.
tagstr: Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
inst_idstr: Instrument ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
keep_original_namesbool: If True then the names as given in the netCDF ICON file will be used as is. If False, a preamble is removed. (default=False)

Returns:

dataxr.Dataset: An xarray Dataset with data prepared for the pysat.Instrument
metapysat.Meta: Metadata formatted for a pysat.Instrument object.

Examples

inst = pysat.Instrument('icon', 'euv', tag='', inst_id='a')
inst.load(2020, 1)

pysatNASA.instruments.icon_euv.preprocess(self, keep_original_names=False)[source]

Adjust epoch timestamps to datetimes and remove variable preambles.

Parameters:

keep_original_namesbool: if True then the names as given in the netCDF ICON file will be used as is. If False, a preamble is removed. (default=False)

ICON FUV

Module for the ICON FUV instrument.

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

Properties

platform: ‘icon’
name: ‘fuv’
tag: None supported
inst_id: None Supported

Warnings

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)

pysatNASA.instruments.icon_fuv.clean(self)[source]: Clean ICON FUV data to the specified level.

pysatNASA.instruments.icon_fuv.filter_metadata(meta_dict)[source]

Filter FUV metadata to remove warnings during loading.

Parameters:

meta_dictdict: Dictionary of metadata from file

Returns:

meta_dictdict: Filtered FUV metadata

pysatNASA.instruments.icon_fuv.load(fnames, tag='', inst_id='', keep_original_names=False)[source]

Load ICON FUV data into xarray.Dataset object and pysat.Meta objects.

This routine is called as needed by pysat. It is not intended for direct user interaction.

Parameters:

fnamesarray-like: iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.
tagstr: Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
inst_idstr: Instrument ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
keep_original_namesbool: if True then the names as given in the netCDF ICON file will be used as is. If False, a preamble is removed. (default=False)

Returns:

dataxr.Dataset: An xarray Dataset with data prepared for the pysat.Instrument
metapysat.Meta: Metadata formatted for a pysat.Instrument object.

Examples

inst = pysat.Instrument('icon', 'fuv')
inst.load(2020, 1)

pysatNASA.instruments.icon_fuv.preprocess(self, keep_original_names=False)[source]

Adjust epoch timestamps to datetimes and remove variable preambles.

Parameters:

keep_original_namesbool: if True then the names as given in the netCDF ICON file will be used as is. If False, a preamble is removed. (default=False)

ICON IVM

Module for the ICON IVM instrument.

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

Properties

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

Example

import pysat
ivm = pysat.Instrument(platform='icon', name='ivm', inst_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', inst_id='a',
                       keep_original_names=True)

Author

1. Stoneback

pysatNASA.instruments.icon_ivm.clean(self)[source]: Clean ICON IVM data to the specified level.

pysatNASA.instruments.icon_ivm.filter_metadata(meta_dict)[source]

Filter IVM metadata to remove warnings during loading.

Parameters:

meta_dictdict: Dictionary of metadata from file

Returns:

dict: Filtered IVM metadata

pysatNASA.instruments.icon_ivm.load(fnames, tag='', inst_id='', keep_original_names=False)[source]

Load ICON IVM data into pandas.DataFrame and pysat.Meta objects.

This routine is called as needed by pysat. It is not intended for direct user interaction.

Parameters:

fnamesarray-like: iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.
tagstr: Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
inst_idstr: Instrument ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
keep_original_namesbool: if True then the names as given in the netCDF ICON file will be used as is. If False, a preamble is removed. (default=False)

Returns:

datapds.DataFrame: A pandas DataFrame with data prepared for the pysat.Instrument
metapysat.Meta: Metadata formatted for a pysat.Instrument object.

Examples

inst = pysat.Instrument('icon', 'ivm', inst_id='a', tag='')
inst.load(2020, 1)

pysatNASA.instruments.icon_ivm.preprocess(self, keep_original_names=False)[source]

Remove variable preambles.

Parameters:

keep_original_namesbool: if True then the names as given in the netCDF ICON file will be used as is. If False, a preamble is removed. (default=False)

ICON MIGHTI

Module for the ICON MIGHTI instrument.

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.

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 inst_id
inst_id: ‘vector’, ‘a’, or ‘b’

Warnings

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

Example

import pysat
mighti = pysat.Instrument('icon', 'mighti', tag='vector_wind_green',
                          inst_id='vector', 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', inst_id='vector',
                          clean_level='clean',
                          keep_original_names=True)

Note

Currently red and green data products are bundled together in zip files on the server. This results in ‘double downloading’. This will be fixed once data is transfered to SPDF.

pysatNASA.instruments.icon_mighti.clean(self)[source]: Clean ICON MIGHTI data to the specified level.

pysatNASA.instruments.icon_mighti.filter_metadata(meta_dict)[source]

Filter FUV metadata to remove warnings during loading.

Parameters:

meta_dictdict: Dictionary of metadata from file

Returns:

meta_dictdict: Filtered FUV metadata

pysatNASA.instruments.icon_mighti.load(fnames, tag='', inst_id='', keep_original_names=False)[source]

Load ICON MIGHTI data into xarray.Dataset and pysat.Meta objects.

This routine is called as needed by pysat. It is not intended for direct user interaction.

Parameters:

fnamesarray-like: iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.
tagstr: Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
inst_idstr: Instrument ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
keep_original_namesbool: if True then the names as given in the netCDF ICON file will be used as is. If False, a preamble is removed. (default=False)

Returns:

dataxr.Dataset: An xarray Dataset with data prepared for the pysat.Instrument
metapysat.Meta: Metadata formatted for a pysat.Instrument object.

Examples

inst = pysat.Instrument('icon', 'fuv')
inst.load(2020, 1)

pysatNASA.instruments.icon_mighti.preprocess(self, keep_original_names=False)[source]

Adjust epoch timestamps to datetimes and remove variable preambles.

Parameters:

keep_original_namesbool: if True then the names as given in the netCDF ICON file will be used as is. If False, a preamble is removed. (default=False)

IGS GPS

Module for the IGS GPS data products.

Supports GPS data produced from International GNSS Service Total Electron Content (TEC).

From CDAWeb (modified):

This directory contains the GPS Total Electron Content (TEC) data produced by the International Global Navigation Satellite Systems Service (IGS) Ionosphere Working Group and by the Analysis Centers that have contributed to the IGS data including CODE of the University of Bern (Switzerland), ESA of the European Space Operations Center (ESOC) in Darmstadt (Germany), JPL of the Jet Propulsion Laboratory, Pasadena (USA), and UPC of the University Politechnical Catalonia in Barcelona (Spain). The IGS data are a computed as a weighted mean of the data from the four analysis centers.

The rate of TEC index (ROTI) characterizes TEC fluctuations observed along receiver-to-satellite line of sight links over a 5-minute interval. The measurement is obtained by processing GNSS dual-frequency phase data and computing the standard deviation of the rate of TEC change over that interval after removing its background variation trend.

ROTI data are provided as global maps using a 2.5 x 5 degree (geographic latitude x longitude) grid. The median ROTI value is calculated in each bin. GNSS data contributing to the ROTI computation are primarily collected from the global network of International GNSS Service and the regional network of Continuous Operating Reference Station (CORS).

Properties

platform: ‘igs’
name: ‘gps’
tag: [‘tec’, ‘roti’]
inst_id: [‘15min’, ‘1hr’, ‘2hr’]

Warnings

The cleaning parameters for the instrument are still under development.

References

M. Hernández-Pajares, J.M. Juan, J. Sanz, R. Orus, A. Garcia-Rigo, J. Feltens, A. Komjathy, S.C. Schaer, and A. Krankowski, The IGS VTEC maps: a reliable source of ionospheric information since 1998Journal of Geodesy (2009) 83:263–275 doi:10.1007/s00190-008-0266-1

Feltens, J., M. Angling, N. Jackson‐Booth, N. Jakowski, M. Hoque, M. Hernández‐Pajares, A. Aragón‐Àngel, R. Orús, and R. Zandbergen (2011), Comparative testing of four ionospheric models driven with GPS measurements, Radio Sci., 46, RS0D12, doi:10.1029/2010RS004584

Peng Chen, Hang Liu, Yongchao Ma, Naiquan Zheng, Accuracy and consistency of different global ionospheric maps released by IGS ionosphere associate analysis centers, Advances in Space Research, Volume 65, Issue 1, 2020, Pages 163-174, doi:10.1016/j.asr.2019.09.042.

ISS FPMU

Module for the ISS FPMU instrument.

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

Properties

platform: ‘iss’
name: ‘fpmu’
tag: None Supported
inst_id: None supported

Warnings

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

JPL GPS

Module for the JPL GPS data products.

Deprecated since version 0.0.5: This module is now included in igs_gps.py. This instrument will be removed in 0.1.0+ to reduce redundancy.

Supports ROTI data produced at JPL from International GNSS Service Total Electron Content (TEC)

The rate of TEC index (ROTI) characterizes TEC fluctuations observed along receiver-to-satellite line of sight links over a 5-minute interval. The measurement is obtained by processing GNSS dual-frequency phase data and computing the standard deviation of the rate of TEC change over that interval after removing its background variation trend.

ROTI data are provided as global maps using a 2.5 x 5 degree (geographic latitude x longitude) grid. The median ROTI value is calculated in each bin. GNSS data contributing to the ROTI computation are primarily collected from the global network of International GNSS Service and the regional network of Continuous Operating Reference Station (CORS).

Properties

platform: ‘jpl’
name: ‘gps’
tag: [‘roti’]
inst_id: None supported

Warnings

The cleaning parameters for the instrument are still under development.

References

Pi, X., A. J. Mannucci, U. J. Lindqwister, and C. M. Ho, Monitoring of global ionospheric irregularities using the worldwide GPS network, Geophys. Res. Lett., 24, 2283, 1997.

Pi, X., F. J. Meyer, K. Chotoo, Anthony Freeman, R. G. Caton, and C. T. Bridgwood, Impact of ionospheric scintillation on Spaceborne SAR observations studied using GNSS, Proc. ION-GNSS, pp.1998-2006, 2012.

pysatNASA.instruments.jpl_gps.init(self)[source]

Initialize the Instrument object with instrument specific values.

Runs once upon instantiation.

MAVEN INSITU KP

Module for the MAVEN insitu instruments.

Supports the in situ Key Parameter (kp) data from multiple instruments onboard the Mars Atmosphere and Volatile Evolution (MAVEN) satellite.

Accesses local data in CDF format. Downloads from CDAWeb.

Properties

platform: ‘maven’
name: ‘insitu_kp’
tag: None supported
inst_id: None supported

Examples

::

import pysat

insitu = pysat.Instrument(platform=’maven’, name=’insitu_kp’) insitu.download(dt.datetime(2020, 1, 1), dt.datetime(2020, 1, 31)) insitu.load(2020, 1, use_header=True)

MAVEN MAG

Module for the MAVEN mag instrument.

Supports the Magnetometer (MAG) onboard the Mars Atmosphere and Volatile Evolution (MAVEN) satellite. Accesses local data in CDF format. Downloads from CDAWeb.

Properties

platform: ‘maven’
name: ‘mag’
tag: None supported
inst_id: None supported

Warnings

Only supports level-2 sunstate 1 second data.

Examples

::

import pysat

mag = pysat.Instrument(platform=’maven’, name=’mag’) mag.download(dt.datetime(2020, 1, 1), dt.datetime(2020, 1, 31)) mag.load(2020, 1, use_header = True)

MAVEN SEP

OMNI HRO

Module for the OMNI HRO instrument.

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.

Properties

platform: ‘omni’
name: ‘hro’
tag: Select time between samples, one of {‘1min’, ‘5min’}
inst_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.

Warnings

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.

pysatNASA.instruments.omni_hro.calculate_clock_angle(*args, **kwargs)[source]: Wrap functions that use the decorator function.

pysatNASA.instruments.omni_hro.calculate_imf_steadiness(*args, **kwargs)[source]: Wrap functions that use the decorator function.

pysatNASA.instruments.omni_hro.time_shift_to_magnetic_poles(*args, **kwargs)[source]: Wrap functions that use the decorator function.

REACH DOSIMETER

The REACH dosimeter instrument.

Supports the dosimeter instrument on the Responsive Environmental Assessment Commercially Hosted (REACH) mission.

The Responsive Environmental Assessment Commercially Hosted (REACH) constellation is collection of 32 small sensors hosted on six orbital planes of the Iridium-Next space vehicles in low earth orbit. Each sensor contains two micro-dosimeters sensitive to the passage of charged particles from the Earth’s radiation belts. There are six distinct dosimeter types spread among the 64 individual sensors, which are unique in shielding and electronic threshold. When taken together, this effectively enables a high time-cadence measurement of protons and electrons in six integral energy channels over the entire globe.

Properties

platform: ‘reach’
name: ‘dosimeter’
tag: None Supported
inst_id: ‘101’, ‘102’, ‘105’, ‘108’, ‘113’, ‘114’, ‘115’, ‘116’, ‘133’, ‘134’, ‘135’, ‘136’, ‘137’, ‘138’, ‘139’, ‘140’, ‘148’, ‘149’, ‘162’, ‘163’, ‘164’, ‘165’, ‘166’, ‘169’, ‘170’, ‘171’, ‘172’, ‘173’, ‘175’, ‘176’, ‘180’, ‘181’

pysatNASA.instruments.reach_dosimeter.load(fnames, tag=None, inst_id=None)[source]

Load REACH data into pandas.DataFrame and pysat.Meta objects.

This routine is called as needed by pysat. It is not intended for direct user interaction.

Parameters:

fnamesarray-like: iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.
tagstr: tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself.
inst_idstr: Satellite ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself.

Returns:

datapds.DataFrame: A pandas DataFrame with data prepared for the pysat.Instrument
metapysat.Meta: Metadata formatted for a pysat.Instrument object.

Examples

inst = pysat.Instrument('reach', 'dosimeter', inst_id='101', tag='')
inst.load(2020, 1)

pysatNASA.instruments.reach_dosimeter.preprocess(self)[source]: Update acknowledgement with info from file.

SES14 GOLD

Module for the SES14 GOLD instrument.

Supports the Nmax data product from the Global Observations of the Limb and Disk (GOLD) satellite. Accesses data in netCDF format.

Properties

platform: ‘ses14’
name: ‘gold’
tag: ‘nmax’ ‘tlimb’ ‘tdisk’ ‘o2den’
inst_id: None Supported

Warnings

The cleaning parameters for the instrument are still under development.
Loading multiple days of data requires a bugfix in pysat 3.1.0 or higher.

Note

In roughly 0.3% of daily files, Channel A and Channel B scans begin at the same time. One microsecond is added to Channel B to ensure uniqueness in the xarray index. The nominal scan rate for each channel is every 30 minutes.

Examples

import datetime as dt
import pysat
nmax = pysat.Instrument(platform='ses14', name='gold', tag='nmax')
nmax.download(dt.datetime(2020, 1, 1), dt.datetime(2020, 1, 31))
nmax.load(2020, 1)

pysatNASA.instruments.ses14_gold.download(date_array, tag='', inst_id='', data_path=None)[source]

Download NASA GOLD data.

This routine is intended to be used by pysat instrument modules supporting a particular NASA CDAWeb dataset.

Parameters:

date_arrayarray-like: Array of datetimes to download data for. Provided by pysat.
tagstr: Data product tag (default=’’)
inst_idstr: Instrument ID (default=’’)
data_pathstr or NoneType: Path to data directory. If None is specified, the value previously set in Instrument.files.data_path is used. (default=None)

pysatNASA.instruments.ses14_gold.list_remote_files(tag='', inst_id='', start=None, stop=None, series_out=True)[source]

List every file for remote GOLD data.

This routine is intended to be used by pysat instrument modules supporting a particular NASA CDAWeb dataset.

Parameters:

tagstr: Data product tag (default=’’)
inst_idstr: Instrument ID (default=’’)
startdt.datetime or NoneType: Starting time for file list. A None value will start with the first file found. (default=None)
stopdt.datetime or NoneType: Ending time for the file list. A None value will stop with the last file found. (default=None)
series_outbool: boolean to determine output type. True for pandas series of file names, and False for a list of the full web address. (default=True)

Returns:

file_listlist: A list containing the verified available files

pysatNASA.instruments.ses14_gold.load(fnames, tag='', inst_id='')[source]

Load GOLD NMAX data into xarray.Dataset and pysat.Meta objects.

This routine is called as needed by pysat. It is not intended for direct user interaction.

Parameters:

fnamesarray-like: iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.
tagstr: Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
inst_idstr: Instrument ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)
**kwargsextra keywords: Passthrough for additional keyword arguments specified when instantiating an Instrument object. These additional keywords are passed through to this routine by pysat.

Returns:

dataxr.Dataset: An xarray Dataset with data prepared for the pysat.Instrument
metapysat.Meta: Metadata formatted for a pysat.Instrument object.

Examples

inst = pysat.Instrument('ses14', 'gold', tag='nmax')
inst.load(2019, 1)

TIMED GUVI

Module for the TIMED GUVI instrument.

Supports the Global UltraViolet Imager (GUVI) instrument on the Thermosphere Ionosphere Mesosphere Energetics Dynamics (TIMED) satellite data from the NASA Coordinated Data Analysis Web (CDAWeb).

From JHU APL:

The Global Ultraviolet Imager (GUVI) is one of four instruments that constitute the TIMED spacecraft, the first mission of the NASA Solar Connections program. The TIMED spacecraft is being built by Johns Hopkins University Applied Physics Laboratory and GUVI is a joint collaboration between JHU/APL and the Aerospace Corporation. TIMED will be used to study the energetics and dynamics of the Mesosphere and lower Thermosphere between an altitude of approximately 60 to 180 kilometers.

References

Larry J. Paxton, Andrew B. Christensen, David C. Humm, Bernard S. Ogorzalek, C. Thompson Pardoe, Daniel Morrison, Michele B. Weiss, W. Crain, Patricia H. Lew, Dan J. Mabry, John O. Goldsten, Stephen A. Gary, David F. Persons, Mark J. Harold, E. Brian Alvarez, Carl J. Ercol, Douglas J. Strickland, and Ching-I. Meng “Global ultraviolet imager (GUVI): measuring composition and energy inputs for the NASA Thermosphere Ionosphere Mesosphere Energetics and Dynamics (TIMED) mission”, Proc. SPIE 3756, Optical Spectroscopic Techniques and Instrumentation for Atmospheric and Space Research III, (20 October 1999); https://doi.org/10.1117/12.366380

Properties

platform: ‘timed’
name: ‘guvi’
tag: ‘edr-aur’ ‘sdr-imaging’ ‘sdr-spectrograph’
inst_id: ‘’ ‘high_res’ ‘low_res’

Warnings

Currently no cleaning routine.

Example

import pysat
guvi = pysat.Instrument(platform='timed', name='guvi',
                        inst_id='sdr-imaging', tag='low_res')
guvi.download(dt.datetime(2005, 6, 28), dt.datetime(2005, 6, 29))
guvi.load(date=dt.datetime(2005, 6, 28))

pysatNASA.instruments.timed_guvi.clean(self)[source]: Clean TIMED GUVI imaging data.

pysatNASA.instruments.timed_guvi.concat_data(self, new_data, combine_times=False, **kwargs)[source]

Concatonate data to self.data for TIMED GUVI data.

Parameters:

new_dataxarray.Dataset or list of such objects: New data objects to be concatonated
combine_timesbool: For SDR data, optionally combine the different datetime coordinates into a single time coordinate (default=False)
**kwargsdict: Optional keyword arguments passed to xr.concat

pysatNASA.instruments.timed_guvi.load(fnames, tag='', inst_id='', combine_times=False)[source]

Load TIMED GUVI data into xarray.DataSet and pysat.Meta objects.

This routine is called as needed by pysat. It is not intended for direct user interaction.

Parameters:

fnamesarray-like: iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.
tagstr: tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself.
inst_idstr: Satellite ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself.
combine_timesbool: For SDR data, optionally combine the different datetime coordinates into a single time coordinate (default=False)

Returns:

dataxr.DataSet: A xarray DataSet with data prepared for the pysat.Instrument
metapysat.Meta: Metadata formatted for a pysat.Instrument object.

Raises:

ValueError: If temporal dimensions are not consistent

Examples

inst = pysat.Instrument('timed', 'guvi',
                        inst_id='high_res', tag='sdr-imaging')
inst.load(2005, 179)

TIMED SABER

The TIMED SABER instrument.

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

Properties

platformstr: ‘timed’
namestr: ‘saber’
tagstr: None supported
inst_idstr: None supported

Note

Note on Temperature Errors: https://saber.gats-inc.com/temp_errors.php

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.

Warnings

No cleaning routine

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.

Properties

platform: ‘timed’
name: ‘see’
tag: None
inst_id: None supported

Note

no tag required
cdflib load routine raises ISTP Compliance Warnings for several variables. This is due to how the Epoch is listed in the original files.

Warnings

Currently no cleaning routine.