sampex 0.3.0

'Programs to load and plot the SAMPEX satellite data.'

sampex

Easily load and plot data from the Solar Anomalous and Magnetospheric Particle Explorer (SAMPEX) satellite that operated from 1992-2012. This library currently loads data from the HILT, PET, and LICA instruments, as well as the attitide files.

Documentation

The example plot below sums up what this library does. I generated it with this console command: plot_sampex 2007 1 20 --yscale log

Install

Installing this package is as simple as

python3 -m pip install sampex

If you want to develop this package, run

git clone [e-mail]:mshumko/sampex.git
cd sampex

Then one of these commands to install sampex into a virtual environment:

python3 -m pip install -e .

or

python3 -m pip install -r requirements.txt 

Get started

Before you can load the SAMPEX data you'll need to do two things:

1. Download the SAMPEX data to a folder. wget is great for this. Write down the top-level SAMPEX data directory as you'll need it in step 2.

2. Configure this package as it needs to know what directory to begin searching for the SAMPEX data.

   python3 -m sampex config
   

   and in the prompt paste the top-level SAMPEX data directory.

Examples

There are a handful of examples in the documentation