Calculation of indices that describe the Madden-Julian-Oscillation (only OMI by now)
mjoindices - A python package for calculating the Madden-Julian-Oscillation OMI index
mjoindices is a Python package relevant for users of the atmospheric sciences. It provides functionality to compute an index of the Madden-Julian-Oscillation (MJO), particularly the OLR-based MJO index (OMI).
Whereas the package name has been chosen to indicate that further MJO indices should be included in future, the implementation is currently limited to the OMI algorithm.
A scientific description of the packge is found in Hoffmann et al. (2021).
If you use mjoindices in published research, please cite the correspondig paper: Hoffmann, C.G., Kiladis, G.N., Gehne, M. and von Savigny, C., 2021. A Python Package to Calculate the OLR-Based Index of the Madden- Julian-Oscillation (OMI) in Climate Science and Weather Forecasting. Journal of Open Research Software, 9(1), p.9. DOI: http://doi.org/10.5334/jors.331
In addition, you can also cite the Zenodo DOI http://dx.doi.org/10.5281/zenodo.3613752.
mjoindices is written for Python 3 (version > 3.6) and depends on the packages NumPy, Pandas, SciPy, and Matplotlib. It runs on Linux and Windows. Other operating systems have not been tested.
mjoindices is available in the Python Package Index (PyPI). It can be installed using, e.g., pip.
pip3 install mjoindices
python3 setup.py install
Getting started / examples
After you have installed mjoindices, you can download an example from the source, which consists of two files:
recalculate_original_omi.py: After downloading some data files, which are mentioned and linked in the source documentation of the example, you can run this example to recalculate the original OMI values. The script will save the computed Empirical Orthogonal Functions (EOFs) and the Principal Components (PCs) in two individual files, which can also be configured in the source code. In addition, it will save a few plots into a directory, which can also be configured in the source. These plots show the agreement with the original OMI values (slight deviations are expected due to numerical differences. This will be detailed in the corresponding software meta paper).
Note that you can use this example also as a template to calculate OMI values with your own OLR data. In order to do that, you have to adapt only two parts of the code, which are also marked in the code documentation.
Note also that this script may run for one or two hours on common personal computer systems.
evaluate_omi_reproduction.py: This script produces more detailed comparison plots and saves them into a directory. The script recalculate_original_omi.py has to be run before, as the evaluation script is based on the saved results. As for recalculate_original_omi.py, some file and directory names have to be adapted in the beginning of the code.
Both files are also available as Jupyter notebook files.
After you have installed mjoindices, you can also download unit and integration tests from the source to check your installation using pytest.
Download the complete test directory to you local file system.
Move into your local test directory and run
Note that the tests may run for a few hours on a common personal computer.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for mjoindices-1.3.0-py3-none-any.whl