References and citation hints
=============================
The following publications are closely related to the mjoindices software package. Please consider citing them
in published research based on the descriptions given below.

Peer-reviewed
-------------

.. _refHoffmann2021:

Hoffmann et al. (2021)
~~~~~~~~~~~~~~~~~~~~~~

* Scientific description of this software package to compute OMI including a validation against the originally calculated values.
* Should always be cited when OMI values are calculated using this software package.
* **Reference**: 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

.. _refKiladis2014:

Kiladis et al. (2014)
~~~~~~~~~~~~~~~~~~~~~

* Initial paper of OMI, which contains the basic scientific description of the calculation approach.
* Should always be cited when OMI values are used.
* **Reference:** Kiladis, G.N., J. Dias, K.H. Straub, M.C. Wheeler, S.N. Tulich, K. Kikuchi, K.M. Weickmann, and M.J. Ventrice (2014): A Comparison of OLR and Circulation-Based
  Indices for Tracking the MJO. Mon. Wea. Rev., 142, 1697-1715, https://doi.org/10.1175/MWR-D-13-00301.1

.. _refWeidman2022:

Weidman et al. (2022)
~~~~~~~~~~~~~~~~~~~~~~

* Description of an alternative procedure for the EOF post-processing, which reduces noise and avoids potential degeneracy issues.
* Should be cited when this particular post-processing option is used for the calculations.
* **Reference:** Weidman, S., Kleiner, N., & Kuang, Z. (2022). A rotation procedure
  to improve seasonally varying empirical orthogonal function bases for MJO indices. Geophysical Research Letters,
  49, e2022GL099998. https://doi.org/10.1029/2022GL099998

Others
------

.. _refHoffmann2020aZenodoCode:

Hoffmann (2020a)
~~~~~~~~~~~~~~~~
* Persistent storage of the package source code.
* Can be cited to reference particularly the source code in "Code and Data" sections of papers
  (in addition to :ref:`refHoffmann2021`, which should at least be cited in the text).
* **Reference:** Hoffmann, C.G. (2020). mjoindices. Zenodo. https://doi.org/10.5281/zenodo.3613752

.. _refHoffmann2020bZenodoTestData:

Hoffmann et al. (2020b)
~~~~~~~~~~~~~~~~~~~~~~~
* Persistent storage of the reference data for unit tests and validation.
* Can be cited if this data is of particular importance for a publication, e.g., if an OMI advancement is validated in a paper.
* **Reference:** Hoffmann, C.G., Kiladis, G.N., Gehne, M., Dias, J. and Smith, C. (2020). Reference dataset to check the Python package for the calculation of the OLR-based MJO index (OMI) (1.0) [Data set]. Zenodo. https://doi.org/10.5281/zenodo.3746563

.. _refKiladis2020:

Kiladis et al. (2020)
~~~~~~~~~~~~~~~~~~~~~

* A correction to :ref:`refKiladis2014` showing the correct values of the explained variance of the EOFs, which are also reproduced by
  the present software package. In fact, the mistake in :ref:`refKiladis2014` was discovered during the development of this package in close collaboration
  with the authors.
* Should be cited if the right values of explained variance of the EOFs are of particular interest.
* **Reference:** Kiladis, G. N., Dias, J., Straub, K. H., Wheeler, M. C., Tulich, S. N., Kikuchi, K., Weickmann, K. M., and Ventrice, M. J. (2020).
  CORRIGENDUM, Monthly Weather Review, 148(2), 875-876, https://doi.org/10.1175/MWR-D-19-0385.1