Python Space Physics Environment Data Analysis
Project description
The Python package pyrfu is a software based on the IRFU-MATLAB library to work with space data, particularly the Magnetospheric MultiScale (MMS) mission.
It is distributed under the open-source MIT license.
Full documentation can be found here
Instalation
The package pyrfu has been tested only for Mac OS. pyrfu requires FFTW3 . Install FFTW3 using homebrew and set temporary environmental variables, such that pyrfu finds fftw:
brew install fftw
export DYLD_LIBRARY_PATH=/usr/local/lib
export LDFLAGS="-L/usr/local/lib"
export CFLAGS="-I/usr/local/include"Using PyPi
pyrfu is available for pip.
pip install pyrfuFrom sources
The sources are located on GitHub:
Clone the GitHub repo:
Open a terminal and write the below command to clone in your PC the pyrfu repo:
git clone https://github.com/louis-richard/irfu-python.git
cd pyrfuCreate a virtual env
pyrfu needs a significant number of dependencies. The easiest way to get everything installed is to use a virtual environment.
Anaconda
You can create a virtual environment and install all the dependencies using conda with the following commands:
pip install conda
conda create -n pyrfu
source activate pyrfuVirtual Env
Virtualenv can also be used:
pip install virtualenv
virtualenv pyrfu
source pyrfu/bin/activateInstall the package via the commands:
python setup.py install5) (Optional) Generate the docs: install the extra dependencies of doc and run the setup.py file:
pip install pyrfu
python setup.py build_sphinxOnce installed, the doc can be generated with:
cd doc
make htmlDependencies
The required dependencies are:
astropy >=4.0.0
cycler >=0.10.0
cdflib >=0.3.20
cython >=0.29.21
matplotlib >=3.2.1
numba >=0.52.0
numpy >=1.18.1
Pillow >=7.1.0
pandas >=1.0.3
pyfftw >=0.12.0
python-dateutil >=2.8.1
requests >=2.23.0
Sphinx >=3.0.3
scipy >=1.4.1
seaborn >=0.10.1
setuptools >=47.3.1
sfs >=0.5.0
tqdm >=4.46.0
xarray >=0.15.0
Testing dependencies are:
pytest >= 2.8
Extra testing dependencies:
Usage
To import generic space plasma physics functions
from pyrfu import pyrfTo import functions specific to MMS mission
from pyrfu import mmsTo import plotting functions
from pyrfu import plot as pltrfConfiguration
Configuration settings are set in the CONFIG hash table in the mms_config.py file.
Credits
This software was developped by Louis RICHARD (louisr@irfu.se) based on the IRFU-MATLAB library.
Acknowledgement
Please use the following to acknowledge use of pyrfu in your publications: Data analysis was performed using the pyrfu analysis package available at https://github.com/louis-richard/irfu-python
Additional Information
MMS Science Data Center: https://lasp.colorado.edu/mms/sdc/public/
MMS Datasets: https://lasp.colorado.edu/mms/sdc/public/datasets/
MMS - Goddard Space Flight Center: http://mms.gsfc.nasa.gov/
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
