Installation

The following instructions will allow you to install pysatNASA.

Prerequisites

powered by pysat Logo, blue planet with orbiting python

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

Common modules

Community modules

beautifulsoup4

cdflib>=0.4.4

lxml

pysat>=3.1.0

netCDF4

numpy

pandas

requests

xarray

Installation Options

1. Clone the git repository

git clone https://github.com/pysat/pysatNASA.git
  1. Install pysatNASA: Change directories into the repository folder and build the project. There are a few ways you can do this:

    1. Install on the system (root privileges required):

      sudo pip install .
      
    2. Install at the user level:

      pip install --user .
      
    3. Install with the intent to change the code:

      pip install --user -e .
      

Attention

This module has the following additional requirement:

pysatcdf

This can be installed as follows:

python -m pip install pysatNASA[pysatcdf]

Attention

This module has the following additional requirements:

coveralls<3.3
flake8
flake8-docstrings
hacking>=1.0
pytest
pytest-cov
pytest-ordering

These can be installed as follows:

python -m pip install pysatNASA[test]

Attention

This module has the following additional requirements:

extras-require
ipython
m2r2
numpydoc
sphinx
sphinx-rtd-theme

These can be installed as follows:

python -m pip install pysatNASA[doc]

Post Installation

After installation, you may register the pysatNASA Instrument sub-modules with pysat. If this is your first time using pysat, check out the quickstart guide for pysat. Once pysat is set up, you may choose to register the the pysatNASA Instruments sub-modules by:

import pysat
import pysatNASA

pysat.utils.registry.register_by_module(pysatNASA.instruments)

You may then use the pysat platform and name keywords to initialize the model Instrument instead of the inst_module keyword argument.