Supported Instruments

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

Properties

platform

‘cosmic’

name

‘gps’ for Radio Occultation profiles

tag
Select profile type, or scintillation, using one of the following keys:

  • ‘ionprf’: ‘Ionospheric Profiles’,

  • ‘wetprf’: ‘Atmospheric profiles with moisture’,

  • ‘atmprf’: ‘Atmospheric profiles without moisture’,

  • ‘eraprf’: ‘ERA-40 Interim reanalysis data’,

  • ‘gfsprf’: ‘NCEP operational analysis data’,

  • ‘ionphs’: ‘Ionospheric excess phase’,

  • ‘podtec’: ‘Absolute Total Electron Content and auxiliary data’,

  • ‘scnlv1’: ‘S4 scintillation index and auxiliary data’

inst_id

None supported

altitude_bin

Number of kilometers to bin altitude profiles by when loading. Works for all files except tag=’scnlv1’, ‘podtec’, or ‘ionphs’.

Warnings

  • Routine was not produced by COSMIC team

  • Files are labeled with times at minute resolution which can result in multiple COSMIC data profiles at the same time. pysat requires that instruments have monotonic and unique times, thus, to meet pysat requirements a time shift (based upon file/data parameters) is added to each profile to ensure all times are unique. This time shift within a minute is not considered significant given the released data structure. For level-1b data files time shifts are distributed throughout the minute, for level-2 files the time shifts are less than .0001 seconds. The difference in time distribution is related to the availability of a unique combination of parameters at the different file levels.

pysatCDAAC.instruments.cosmic_gps.clean(self)[source]

Return COSMIC GPS data cleaned to the specified level.

Parameters:
selfpysat.Instrument

Instrument class object, whose attribute clean_level is used to return the desired level of data selectivity.

pysatCDAAC.instruments.cosmic_gps.init(self)[source]

Initialize the Instrument object with instrument specific values.

pysatCDAAC.instruments.cosmic_gps.list_files(tag=None, inst_id=None, data_path=None, format_str=None)[source]

Return a Pandas Series of every file for chosen satellite data.

Parameters:
tagstr or NoneType

Denotes type of file to load. (default=None)

inst_idstr or NoneType

Specifies the satellite ID for a constellation. Not used. (default=None)

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)

format_strNoneType

User specified file format not supported here. (default=None)

pysatCDAAC.instruments.cosmic_gps.load(fnames, tag=None, inst_id=None, altitude_bin=None, altitude_bin_num=300)[source]

Load COSMIC GPS files.

Parameters:
fnamespandas.Series

Series of filenames

tagstr or NoneType

tag or None (default=None)

inst_idstr or NoneType

satellite id or None (default=None)

altitude_binint or NoneType

Number of kilometers to bin altitude profiles by when loading. Works for all files except tag=’scnlv1’, ‘podtec’, or ‘ionphs’ as MSL_alt is required in the file. If None, no binning performed. (default=None)

altitude_bin_numint

Number of bins to use when binning profile altitude if altitude_bin is not None. (default=300)

Returns:
outputpandas.DataFrame

Object containing satellite data

metapysat.Meta

Object containing metadata such as column names and units

pysatCDAAC.instruments.cosmic_gps.load_files(files, tag=None, inst_id=None, coords=None)[source]

Load COSMIC data files directly from a given list.

May be directly called by user, but in general is called by load. This is separate from the main load function for future support of multiprocessor loading.

Parameters:
filespandas.Series

Series of filenames

tagstr or NoneType

tag or None (default=None)

inst_idstr or NoneType

satellite id or None (default=None)

coordsdict or NoneType

Dict keyed by data variable name that stores the coordinate name that should be assigned when loading data. If a variable name not provided will default to ‘RO’. (default=None)

Returns:
outputlist of dicts, one per file

Object containing satellite data

COSMIC-2 IVM

Supports IVM data from the COSMIC2 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.

More info about the dataset can be found at https://doi.org/10.5065/t353-c093

Properties

platform

‘cosmic2’

name

‘ivm’

tag

None supported

inst_id

[‘e1’, ‘e2’, ‘e3’, ‘e4’, ‘e5’, ‘e6’]

Warnings

  • Routine was not produced by COSMIC team

Note

Since all six spacecarft are stored in a single zip file at the server, users need only invoke download for one of the spacecraft (i.e., ‘e1’). All others will be updated accordingly.

pysatCDAAC.instruments.cosmic2_ivm.init(self)[source]

Initialize the Instrument object with instrument specific values.

pysatCDAAC.instruments.cosmic2_ivm.load(fnames, tag='', inst_id='')[source]

Load COSMIC2 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

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

Examples

inst = pysat.Instrument('cosmic2', 'ivm', inst_id='e1')
inst.load(2020, 1)