Supported Models

DINEOF

Supports the pyDINEOF model output. pyDINEOF is a Python implementation of the Data INterpolating Emperical Orthogonal Function method. Information about this package can obtained by contacting Russell Stoneback.

Support exported model data from pyDINEOF.

Properties

platform

‘pydineof’

name

‘dineof’

tag

‘’, ‘test’

inst_id

‘’

Note

pyDINEOFs is a Python package that interfaces with a version of Data Interpolation Empirical Orthogonal Functions (DINEOFs). This module couples into the systematic export pyDINEOF format and thus should support all exports from the package.

Specific tags are not listed here as this method is intended to support all pyDINEOF export models. Place the desired model (daily files) at ‘{pysat_data_dir}/pydineof/dineof/{tag}’. Each model series is identified using the tag keyword. It is presumed the default naming scheme of ‘dineof_{year:04d}-{month:02d}-{day:02d}.nc’ has been retained. Use the file_format option for custom filenames.

DINEOFs are a purely data based method that can analyze a data-set, with data gaps, and extract a series of basis functions that optimally reproduce the input data. The quality of the reconstruction is primarily determined by the quantity and quality of the input data.

References

J.-M. Beckers and M. Rixen. EOF calculations and data filling from incomplete oceanographic data sets. Journal of Atmospheric and Oceanic Technology, 20(12):1839-­1856, 2003.

pysatModels.models.pydineof_dineof.download(date_array, tag, inst_id, data_path)[source]

Download pydineof data.

Parameters
  • date_array (array-like) – List of datetimes to download data for. The sequence of dates need not be contiguous.

  • tag (str) – Tag identifier used for particular dataset. This input is provided by pysat.

  • inst_id (str) – Instrument ID string identifier used for particular dataset. This input is provided by pysat.

  • data_path (str) – Path to directory where download data will be stored.

Note

This routine is invoked by pysat and is not intended for direct use by the end user. Currently only retrieves test data from github.

The test object generates the datetime requested by the user, which may not match the date of the model run.

Examples

import datetime as dt
import pysat

inst = pysat.Instrument('pydineof', 'dineof', 'test')
inst.download(start=dt.datetime(2009, 1, 1))
pysatModels.models.pydineof_dineof.init(self)[source]

Initialize the Instrument object with instrument specific values.

pysatModels.models.pydineof_dineof.load(fnames, tag='', inst_id='', **kwargs)[source]

Load pydineof data using xarray.

Parameters
  • fnames (array-like) – Iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.

  • tag (str) – Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)

  • inst_id (str) – Instrument ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)

  • **kwargs (dict) – Pass-through for additional keyword arguments specified when instantiating an Instrument object. These additional keywords are passed through to this routine by pysat.

Returns

  • data (xarray.Dataset) – pysat formatted xarray Dataset

  • meta (pysat.Meta) – Model run meta data

Note

Any additional keyword arguments passed to pysat.Instrument upon instantiation are passed along to this routine.

Examples

inst = pysat.Instrument(inst_module=pysatModels.models.pydineof_dineof)
inst.load(2019, 1)

SAMI2

Supports the SAMI2 (Sami2 is Another Model of the Ionosphere 2) model through the sami2py interface. Sami2py is a python module that runs the SAMI2 model, as well as archives, loads and plots the resulting modeled values. SAMI2 is a model developed by the Naval Research Laboratory to simulate the motions of plasma in a 2D ionospheric environment along a dipole magnetic field [Huba et al, 2000]. Information about this model can be found at the sami2py github page, along with a list of the SAMI2 principle papers.

Support loading data from files generated using the sami2py model.

sami2py file is a netCDF file with multiple dimensions for some variables. The sami2py project is at https://github.com/sami2py/sami2py

Properties

platform

‘sami2py’

name

‘sami2’

tag

‘’, ‘test’

inst_id

‘’

pysatModels.models.sami2py_sami2.download(date_array, tag, inst_id, data_path)[source]

Download sami2py data.

Parameters
  • date_array (array-like) – List of datetimes to download data for. The sequence of dates need not be contiguous.

  • tag (str) – Tag identifier used for particular dataset. This input is provided by pysat.

  • inst_id (str) – Instrument ID string identifier used for particular dataset. This input is provided by pysat.

  • data_path (str) – Path to directory to download data to.

Note

This routine is invoked by pysat and is not intended for direct use by the end user.

The test object generates the datetime requested by the user, which may not match the date of the model run.

Examples

import datetime as dt
import pysat

inst = pysat.Instrument('sami2py', 'sami2', 'test')
inst.download(start=dt.datetime(2020, 3, 8))
pysatModels.models.sami2py_sami2.init(self)[source]

Initialize the Instrument object with instrument specific values.

pysatModels.models.sami2py_sami2.load(fnames, tag='', inst_id='', **kwargs)[source]

Load sami2py data using xarray.

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

Parameters
  • fnames (array-like) – Iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.

  • tag (str) – Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)

  • inst_id (str) – Instrument ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)

  • **kwargs (dict) – Passthrough for additional keyword arguments specified when instantiating an Instrument object. These additional keywords are passed through to this routine by pysat.

Returns

  • data (xarray.Dataset) – pysat formatted xarray Dataset

  • meta (pysat.Metadata) – Model run meta data

Note

Any additional keyword arguments passed to pysat.Instrument upon instantiation are passed along to this routine.

Examples

inst = pysat.Instrument('sami2py', 'sami2')
inst.load(2019, 1)

TIE-GCM

Supports the UCAR (University Corporation for Atmospheric Research) model, Thermosphere-Ionosphere-Electrodynamics General Circulation Model (TIE-GCM). Information about this model can be found at the UCAR TIE-GCM website, along with a list of the principle papers and references.

Support loading data from files generated using TIEGCM model.

TIEGCM (Thermosphere Ionosphere Electrodynamics General Circulation Model) file is a netCDF file with multiple dimensions for some variables.

Properties

platform

‘ucar’

name

‘tiegcm’

tag

‘’

inst_id

‘’

pysatModels.models.ucar_tiegcm.download(date_array, tag, inst_id, data_path=None, **kwargs)[source]

Download UCAR TIE-GCM (placeholder). Doesn’t do anything.

Parameters
  • date_array (array-like) – List of datetimes to download data for. The sequence of dates need not be contiguous.

  • tag (str) – Tag identifier used for particular dataset. This input is provided by pysat.

  • inst_id (str) – Instrument ID string identifier used for particular dataset. This input is provided by pysat.

  • data_path (str or NoneType) – Path to directory to download data to. (default=None)

  • **kwargs (dict) – Additional keywords supplied by user when invoking the download routine attached to a pysat.Instrument object are passed to this routine via kwargs.

Note

This routine is invoked by pysat and is not intended for direct use by the end user.

pysatModels.models.ucar_tiegcm.init(self)[source]

Initialize the Instrument object with instrument specific values.

pysatModels.models.ucar_tiegcm.load(fnames, tag='', inst_id='', **kwargs)[source]

Load TIE-GCM data using xarray.

Parameters
  • fnames (array-like) – Iterable of filename strings, full path, to data files to be loaded. This input is nominally provided by pysat itself.

  • tag (str) – Tag name used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)

  • inst_id (str) – Instrument ID used to identify particular data set to be loaded. This input is nominally provided by pysat itself. (default=’’)

  • **kwargs (dict) – Passthrough for additional keyword arguments specified when instantiating an Instrument object. These additional keywords are passed through to this routine by pysat.

Returns

  • data (xarray.Dataset) – pysat formatted xarray Dataset

  • meta (pysat.Metadata) – Model run meta data

Note

Any additional keyword arguments passed to pysat.Instrument upon instantiation are passed along to this routine.

Examples

inst = pysat.Instrument('ucar', 'tiegcm')
inst.load(2019, 1)