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 >= 3.0.4
pandas
pysatNASA <= 0.0.4
requests
pyForecastTools
scipy
xarray
Installation Options
You may now obtain pysatModels from PyPi, Zenodo, or the GitHub repository. If you use PyPi, simply call:
pip install pysatModels
If you use GitHub or Zenodo, you need to first obtain the package and then install it.
Clone the git repository or download the repository from Zenodo and unzip the compressed files. To clone the git repository, use the command below.
git clone https://github.com/pysat/pysatModels.git
Install pysatModels from the repository folder, once it is in the desired location. Change directories into the repository folder and run the setup.py file. There are a few ways you can do this:
Install on the system (root privileges required):
sudo python3 setup.py install
Install at the user level:
python3 setup.py install --user
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.