Skip to content

pysat/pysatNASA

Repository files navigation

pysatNASA

pysatNASA: pysat support for NASA Space Science instruments

PyPI Package latest release Build Status Coverage Status

Documentation Status DOI

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

Common modules Community modules
beautifulsoup4 cdflib
lxml pysat
netCDF4
numpy
pandas
requests
xarray

GitHub Installation

Currently, the main way to get pysatNASA is through github.

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

Change directories into the repository folder and run the setup.py file. For a local install use the "--user" flag after "install".

cd pysatNASA/
python setup.py install

Note: pre-1.0.0 version

pysatNASA is currently in an initial development phase and requires pysat 3.0.0.

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