xmhw <https://xmhw.readthedocs.io/en/latest>
_XMHW - Xarray based Marine HeatWave code -
.. image:: https://readthedocs.org/projects/xmhw/badge/?version=latest :target: https://xmhw.readthedocs.io/en/latest/ .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7668235.svg :target: https://doi.org/10.5281/zenodo.7668235
.. content-marker-for-sphinx
XMHW identifies marine heatwaves from a timseries of Sea Surface Temperature data and calculates statistics associated to the detected heatwaves. It is based on the marineHeatWaves code <https://github.com/ecjoliver/marineHeatWaves/>
_ by Eric Olivier
Functions:
As this code uses xarray results are xarray datasets.
You can install the latest version of xmhw directly from conda (coecms channel)
conda install -c coecms -c conda-forge xmhw
If you want to install an unstable version or a different branch:
* git clone https://github.com/coecms/xmhw
* git checkout <branch-name> (if installing a a different branch from master)
* cd xmhw
* python setup.py install or pip install ./
use --user with either othe commands if you want to install it in ~/.local
Some examples of how to use the functions and explanations of how the functions work are shown in the readthedocs documentation linked above and the xmhw_demo.ipynb notebook <https://github.com/coecms/xmhw/blob/master/docs/xmhw_demo.ipynb>_
in the docs folder.
Main updates:
Main updates:
Updated coordinates handling following recent updates of xarray
Added a separate workflow if only a single point time-series is passed as input, the functions are called in the same way, the code will check number of dimensions and if when only one dimension I present it will skip the operations needed to work with multidimensional grids
Main updates:
Main updates:
This is a work in progress, I tested both threshold and detect and these can reproduced Eric Olivier results with the data I used. Still I haven't extensively tested this and most unit tests in the code need updating. In particular the code is potentially not ready for timeseries with a 360 days calendar year
I am currently working on block_average and mhw_rank functions.