Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 1.91 KB

installation.rst

File metadata and controls

81 lines (53 loc) · 1.91 KB
Raw

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.7+ and pysat 3.0.0+.

Common modules Community modules

beautifulsoup4

cdflib>=0.4.4

lxml netCDF4 numpy pandas requests xarray

pysat>=3.0.0

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 run the setup.py file. There are a few ways you can do this:

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

      sudo python setup.py install

    2. Install at the user level:

      python setup.py install --user

    3. Install with the intent to develop locally:

      python setup.py develop --user

Post Installation

After installation, you may register the :pypysatNASA :pyInstrument 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 :pypysatNASA :pyInstruments sub-modules by:

import pysat
import pysatNASA

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

You may then use the pysat :pyplatform and :pyname keywords to initialize the model :pyInstrument instead of the :pyinst_module keyword argument.