pysatNASA: pysat support for NASA Space Science instruments

Installation

The following instructions provide a guide for installing pysatNASA and give some examples on how to use the routines

Prerequisites

pysatNASA uses common Python modules, as well as modules developed by and for the Space Physics community. This module officially supports Python 3.6+.

PyPi Installation

pip install pysatNASA

GitHub Installation

git clone https://github.com/pysat/pysatNASA.git

Change directories into the repository folder and build the project. For a local install use the "--user" flag after "install".

cd pysatNASA/
pip install .

Note: pre-1.0.0 version

pysatNASA is currently in an initial development phase and requires pysat 3.1.0.
Feedback and contributions are appreciated.

Using with pysat

The instrument modules are portable and designed to be run like any pysat instrument.

import pysat
from pysatNASA.instruments import icon_ivm

ivm = pysat.Instrument(inst_module=icon_ivm, inst_id='a')

Another way to use the instruments in an external repository is to register the instruments. This only needs to be done the first time you load an instrument.
Afterward, pysat will identify them using the platform and name keywords.

import pysat

pysat.utils.registry.register(['pysatNASA.instruments.icon_ivm'])
ivm = pysat.Instrument('icon', 'ivm', inst_id='a')

CDF Integration

For data products stored as CDF files, this package can use either cdflib or pysatCDF. Note that cdflib is a pure python package and more readily deployable across systems, whereas pysatCDF interfaces with the fortran.
This is a faster approach for loading data, but may not install on all systems.
There are known issues with numpy>=1.24. Therefore, pysatCDF is optional rather than required.

You can specify which load routine to use via the optional use_cdflib kwarg. If no kwarg is specified, pysatNASA will default to pysatCDF if it is successfully installed, and default to cdflib otherwise.

ivm = pysat.Instrument('cnofs', 'ivm', use_cdflib=True)