Python Space Physics (RymdFysik) Utilities
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
Installation
The package pyrfu has been tested only for Mac OS.
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 irfu-pythonCreate 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:
cdflib >=0.4.7
geopack >=1.0.9
matplotlib >=3.5.2
numba >=0.54.1
numpy >=1.20.3
pandas >=1.3.4
python-datetutil >=2.8.2
requests >=2.26.0
scipy >=1.7.3
Sphinx >=4.3.0
tqdm >=4.62.3
xarray >=0.20.1
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 Magnetospheric Multi-Scale (MMS)
from pyrfu import mmsTo import functions specific to Solar Orbiter (SolO)
from pyrfu import soloTo import plotting functions
from pyrfu import plotConfiguration
Default configuration settings for MMS data (i.e data path) are stored in pyrfu/mms/config.json and can be changed at anytime using mms.db_init(local_path_dir).
Credits
This software was developed 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.
