This module handles solar and geomagnetic indices needed for scientific and operational projects.

The following instructions provide a guide for installing pysatSpaceWeather and give some examples on how to use the routines

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

Currently, the main way to get pysatSpaceWeather is through github.

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

Change directories into the repository folder and run the setup.py file. For a local install use the "--user" flag after "install".

cd pysatSpaceWeather/
python setup.py install

pysatSpaceWeather is currently in an initial development phase. Much of the API is being built off of the upcoming pysat 3.0.0 software in order to streamline the usage and test coverage. This version of pysat is planned for release in Feb 2021. Currently, you can access the develop version of this through github:

git clone https://github.com/pysat/pysat.git
cd pysat
git checkout develop-3
python setup.py install

It should be noted that this is a working branch and is subject to change.

The instrument modules are portable and designed to be run like any pysat instrument.

import pysat
import pysatSpaceWeather
dst = pysat.Instrument(inst_module=pysatSpaceWeather.instruments.sw_dist)

Another way to use the instruments in an external repository is to register the instruments. This only needs to be done the first time you load an instrument. Afterward, pysat will identify them using the platform and name keywords.

pysat.utils.registry.register('pysatSpaceWeather.instruments.sw_dst')
dst = pysat.Instrument('sw', 'dst')