There is a newer version of the record available.

Published November 8, 2021 | Version 0.7.0
Software Open

XMHW: Xarray based code to identify Marine HeatWave events and their characteristics

Authors/Creators

  • 1. University of Tasmania

Description

XMHW identifies marine heatwaves from a timeseries of sea surface temperature data and calculates statistics associated to the detected heatwaves. This python module is based on the marineHeatWaves code by Eric Olivier.

Main difference with the original code are:

  • We have two separate functions: one to calculate the climatologies and one to detect the heatwaves. 
  • By using xarray sst on a multidimensional grid can be passed as argument
  • We added event severity to the MHW characteristics that are calculated
  • Intermediate results of the detect function can be also returned
  • Results are returned as xarray datasets, with the original spatial dimensions but 'event' instead of  'time' . Each event representing the starting day of an event.

Currently available functions:

  • threshold() - to calculate the percentile and mean climatologies
  • detect() - to detect the MHW events and their main characteristics
  • block_average() - to calculate statistics on blocks of events, still missing "total mhw days per year"

In particular in this version:

  • the threshold function has been re-organised and it is faster
  • added new options to handle NaNs 
  • updated documentation and demo notebook

This code uses python3 and the following modules: xarray, numpy, pandas, dask.

To install clone the repository from GitHub, and from the main directory

python setup.py install --user

This is a work in progress so any feedback/collaboration is appreciated, please create an issue on GitHub.

Notes

For questions, comments and if you find a bug please open an issue on https://github.com/coecms/xmhw. Author email available on orchid account.

Files

xmhw-0.7.0.zip

Files (150.7 kB)

Name Size Download all
md5:093b860c008dad4b3138928b602ee5a2
150.7 kB Preview Download

Additional details

Related works

Funding

Australian Research Council
ARC Centres of Excellence - Grant ID: CE170100023 CE170100023