Installation

The following instructions will allow you to install pysatCDAAC.

Prerequisites

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

Common modules

Community modules

netCDF4

pysat>=3.0.4

numpy

pandas

requests

xarray

Installation Options

1. Clone the git repository

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

Install pysatCDAAC: 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 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 pysatCDAAC[test]

Attention

This module has the following additional requirements:

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

These can be installed as follows:

python -m pip install pysatCDAAC[doc]

Post Installation

After installation, you may register the pysatCDAAC 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 pysatCDAAC Instruments sub-modules by:

import pysat
import pysatCDAAC

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

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