Supported Instruments
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.
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.
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.
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.
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.
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.
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:
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.
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.
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.
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.
Properties
- platform
‘de2’
- name
‘lang’
- inst_id
None Supported
- tag
None Supported
Warnings
Currently no cleaning routine.
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.
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.
Properties
- platform
‘de2’
- name
‘nacs’
- inst_id
None Supported
- tag
None Supported
Warnings
Currently no cleaning routine.
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.
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).
Properties
- platform
‘de2’
- name
‘rpa’
- inst_id
None Supported
- tag
None Supported
Warnings
Currently no cleaning routine.
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.
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.
Properties
- platform
‘de2’
- name
‘wats’
- inst_id
None Supported
- tag
None Supported
Warnings
Currently no cleaning routine.
FORMOSAT-1 IVM
Module for the ICON EUV 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
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.init(self)[source]
Initialize the Instrument object with instrument specific values.
Runs once upon instantiation.
- Parameters
- instpysat.Instrument
Instrument class object
- pysatNASA.instruments.icon_euv.load(fnames, tag=None, inst_id=None, 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.
- tagstring
Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=None)
- inst_idstring
Satellite ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=None)
- keep_original_namesboolean
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_namesboolean
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
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.init(self)[source]
Initialize the Instrument object with instrument specific values.
Runs once upon instantiation.
- Parameters
- instpysat.Instrument
Instrument class object
- pysatNASA.instruments.icon_fuv.load(fnames, tag=None, inst_id=None, 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.
- tagstring
tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself.
- inst_idstring
Satellite ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself.
- keep_original_namesboolean
if True then the names as given in the netCDF ICON file will be used as is. If False, a preamble is removed.
- 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_namesboolean
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)
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.init(self)[source]
Initialize the Instrument object with instrument specific values.
Runs once upon instantiation.
- Parameters
- instpysat.Instrument
Instrument class object
- pysatNASA.instruments.icon_mighti.load(fnames, tag=None, inst_id=None, 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.
- tagstring
tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself.
- inst_idstring
Satellite ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself.
- keep_original_namesboolean
if True then the names as given in the netCDF ICON file will be used as is. If False, a preamble is removed.
- 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_namesboolean
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)
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.
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.
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
- pysatNASA.instruments.omni_hro.calculate_clock_angle(inst)[source]
Calculate IMF clock angle and magnitude of IMF in GSM Y-Z plane.
- Parameters
- instpysat.Instrument
Instrument with OMNI HRO data
- pysatNASA.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)[source]
Calculate IMF steadiness and add parameters to instrument data.
- Parameters
- instpysat.Instrument
Instrument with OMNI HRO data
- steady_windowint
Window for calculating running statistical moments in min (default=15)
- min_window_fracfloat
Minimum fraction of points in a window for steadiness to be calculated (default=0.75)
- max_clock_angle_stdfloat
Maximum standard deviation of the clock angle in degrees (default=22.5)
- max_bmag_cvfloat
Maximum coefficient of variation of the IMF magnitude in the GSM Y-Z plane (default=0.5)
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’
Warnings
The cleaning parameters for the instrument are still under development.
strict_time_flag must be set to False
Examples
import datetime as dt
import pysat
nmax = pysat.Instrument(platform='ses14', name='gold', tag='nmax'
strict_time_flag=False)
nmax.download(dt.datetime(2020, 1, 1), dt.datetime(2020, 1, 31))
nmax.load(2020, 1)
- pysatNASA.instruments.ses14_gold.clean(self)[source]
Clean SES14 GOLD data to the specified level.
Routine is called by pysat, and not by the end user directly.
- Parameters
- selfpysat.Instrument
Instrument class object, whose attribute clean_level is used to return the desired level of data selectivity.
- pysatNASA.instruments.ses14_gold.init(self)[source]
Initialize the Instrument object with instrument specific values.
Runs once upon instantiation.
- Parameters
- selfpysat.Instrument
Instrument class object
- pysatNASA.instruments.ses14_gold.load(fnames, tag=None, inst_id=None)[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.
- tagstring
tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself.
- inst_idstring
Satellite ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself.
- **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('gold', 'nmax') inst.load(2019, 1)
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
- platformstring
‘timed’
- namestring
‘saber’
- tagstring
None supported
- inst_idstring
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.
Warnings
Note on Temperature Errors: http://saber.gats-inc.com/temp_errors.php
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
- 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
Warnings
Currently no cleaning routine.