Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add API documentation to README.md
  • Loading branch information
tammasloughran authored Mar 3, 2024
1 parent f70c638 commit df29616
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ A tool to calculate heatwaves from gridded daily datasets.

[![DOI](https://zenodo.org/badge/41076341.svg)](https://zenodo.org/badge/latestdoi/41076341)


The default definition of a heatwave is any hot event of at least three days
duration where the Excess Heat Factor index is greater than 0.
One could alternatively use the tx90pc index (Tmax greater than the 90th
Expand All @@ -19,6 +18,10 @@ heatwave indicators for any season rather than just annual or seasonal
heatwave aspects. The script has since been expanded and improved to handle
CMIP5 quirks (such different calendars), and use alternative heatwave indices.

## API documentation

http://tammasloughran.github.io/ehfheatwaves

## Installation

Optionaly set up a virtualenv:
Expand Down

0 comments on commit df29616

Please sign in to comment.