Installation

The following instructions will allow you to install pysatMissions.

Prerequisites

pysatMissions uses common Python modules, as well as modules developed by and for the Space Physics community. This module officially supports Python 3.8+ and pysat 3.0.4+.

Common modules	Community modules	Optional Modules
numpy	pysat>=3.0.4	aacgmv2
pandas	pyEphem sgp4>=2.7 skyfield	apexpy OMMBV>=1.0

Installation Options

1. Clone the git repository

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

2. Install pysatMissions: 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 pip install .
      

   2. Install at the user level:

      pip install --user .
      

   3. Install with the intent to develop locally:

      pip install -e --user .
      

Post Installation

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

import pysat
import pysatMissions

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

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