Skip to main content

Calculation of indices that describe the Madden-Julian-Oscillation (only OMI by now)

Project description

mjoindices - A python package for calculating the Madden-Julian-Oscillation OMI index

DOI

Overview

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.

Citation

If you use this software package, you can currently cite the Zenodo DOI. It is planned to publish a peer-reviewed software meta paper in the near-future. Please ask us for the status of this paper, if you use mjoindices in published research. The OMI algorithm itself is described in Kiladis (2014), but please don't forget to also cite the software package, which is an independent development.

Requirements

mjoindices is written for Python 3 and depends on the packages NumPy, Pandas, SciPy, and Matplotlib. It runs on Linux and Windows. Other operating systems have not been tested.

Installation

mjoindices in available in the Python Package Index (PyPI). It can be installed using, e.g., pip.

pip3 install mjoindices

It can also be installed from the source, which is available on GitHub. Download the source, move into the directory containing the file setup.py and run

python3 setup.py install

API documentation

The API documantation is found on GitHub Pages and in the docs folder of the source.

Getting started / examples

After you have installed mjoindices, you can download an example from the source.

  • 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. Furthermore, you can use this example as a template to calculate OMI values with your own OLR data. In order to do that, only two parts of the code have to be changed, which are also marked in the code documentation.

  • evaluate_omi_reproduction.py: After you have run recalculate_original_omi.py (which saves the results), you can check the reproduction quality by using this script. It will show detailed comparison plots.

Both files are also available as Jupyter notebook files.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mjoindices-0.6.3.tar.gz (87.8 kB view hashes)

Uploaded Source

Built Distribution

mjoindices-0.6.3-py3-none-any.whl (77.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page