Installation¶

The following instructions will allow you to install pysatModels.

Prerequisites¶

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

Common modules

Community modules

numpy

pysat

pandas

pyForecastTools

requests

scipy

xarray

Installation Options¶

1. Clone the git repository

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

Install pysatModels: 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 python3 setup.py install
```
2. Install at the user level:
```
python3 setup.py install --user
```
3. Install with the intent to develop locally:
```
python3 setup.py develop --user
```

Post Installation¶

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

import pysat
import pysatModels as pymod

pysat.utils.registry.register_by_module(pymod.models)

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