marineHeatWaves
A module for Python which implements the Marine Heatwave definition of Hobday et al. (2016).
https://github.com/ecjoliver/marineHeatWaves
Category: Hydrosphere
Sub Category: Ocean Carbon and Temperature
Last synced: 30 minutes ago
JSON representation
Repository metadata
marineHeatWaves is a module for python which implements the Marine Heatwave (MHW) definition of Hobday et al. (2016, Prog Ocean).
- Host: GitHub
- URL: https://github.com/ecjoliver/marineHeatWaves
- Owner: ecjoliver
- License: other
- Created: 2015-04-28T07:33:04.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-16T15:38:43.000Z (9 months ago)
- Last Synced: 2025-04-10T05:38:17.561Z (17 days ago)
- Language: Python
- Homepage:
- Size: 5.05 MB
- Stars: 143
- Watchers: 15
- Forks: 80
- Open Issues: 9
- Releases: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- License: LICENSE.txt
README.md
Marine Heatwaves detection code
marineHeatWaves is a module for python which implements the Marine Heatwave (MHW) definition of Hobday et al. (2016). A version written in R is also available.
Contents
| File | Description |
|---|---|
| CHANGES.txt | A list of software versions and changes |
| docs/ | Documentation folder |
| LICENSE.txt | Software license information |
| marineHeatWaves.py | marineHeatWaves module |
| README.md | This file |
| setup.py | Installation script (see below) |
Installation
This module can be installed one of two ways:
- Standard python install. On Linux/UNIX or OS X run the following command in the terminal:
python setup.py install
or on windows run this at the command prompt (not tested)
setup.py install
- Alternatively just copy the marineHeatWaves.py to your working directory or any other directory from which Python can import modules.
Prequisite Python modules include numpy, scipy, and datetime.
Documentation and Usage
Inside the documentation folder are the following helpful files and scripts:
| File | Description |
|---|---|
| marineHeatWaves_manual.htm | HTML file of IPython notebook outlining use of marineHeatWaves code to detect the "big three" historical marine heatwaves. Original data files (NOAA OI SST hi-res) not supplied due to copyright. |
| example_synthetic.ipynb | IPython notebook outlining use of marineHeatWaves code to detect events from a synthetic time series. This notebook can be run by the user as it relies only on internally-generated synthetic temperature data. |
| example_synthetic.html | Static HTML version of example_synthetic.ipynb. |
| mhw_stats.py | Script with some examples of how to output plots, stats, and data files from marineHeatWaves detection code. Requires a subfolder to be created with the name 'mhw_stats', to which all files are output. |
References
Hobday, A.J. et al. (2016), A hierarchical approach to defining marine heatwaves, Progress in Oceanography, 141, pp. 227-238, doi: 10.1016/j.pocean.2015.12.014 pdf
Acknowledgements
The code was written by Eric C. J. Oliver.
Contributors to the Marine Heatwaves definition and its numerical implementation include Alistair J. Hobday, Lisa V. Alexander, Sarah E. Perkins, Dan A. Smale, Sandra C. Straub, Jessica Benthuysen, Michael T. Burrows, Markus G. Donat, Ming Feng, Neil J. Holbrook, Pippa J. Moore, Hillary A. Scannell, Alex Sen Gupta, and Thomas Wernberg.
Contact
Eric C. J. Oliver
Department of Oceanography
Dalhousie University
Halifax, Nova Scotia, Canada
t: (61) 902 494-2505
e: [email protected]
w: http://ecjoliver.weebly.com
w: https://github.com/ecjoliver
Owner metadata
- Name: Eric Oliver
- Login: ecjoliver
- Email:
- Kind: user
- Description: I am an Assistant Professor of Physical Oceanography in the Department of Oceanography, Dalhousie University, Halifax, Nova Scotia, Canada.
- Website: http://ecjoliver.weebly.com
- Location: Halifax, Nova Scotia, Canada
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/971971?u=3ddb368fd8e7bffa3723792ee73dfa75a9757577&v=4
- Repositories: 12
- Last ynced at: 2024-06-11T16:00:20.630Z
- Profile URL: https://github.com/ecjoliver
GitHub Events
Total
- Issues event: 1
- Watch event: 15
- Pull request event: 5
- Fork event: 6
Last Year
- Issues event: 1
- Watch event: 15
- Pull request event: 5
- Fork event: 6
Committers metadata
Last synced: 7 days ago
Total Commits: 48
Total Committers: 2
Avg Commits per committer: 24.0
Development Distribution Score (DDS): 0.167
Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0
| Name | Commits | |
|---|---|---|
| Eric Oliver | e****r@u****u | 40 |
| Eric Oliver | e****r@d****a | 8 |
Committer domains:
- dal.ca: 1
- utas.edu.au: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 7
Total pull requests: 3
Average time to close issues: N/A
Average time to close pull requests: 3 minutes
Total issue authors: 7
Total pull request authors: 3
Average comments per issue: 0.29
Average comments per pull request: 0.0
Merged pull request: 0
Bot issues: 0
Bot pull requests: 0
Past year issues: 1
Past year pull requests: 3
Past year average time to close issues: N/A
Past year average time to close pull requests: 3 minutes
Past year issue authors: 1
Past year pull request authors: 3
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- yuandianyuan (1)
- spetton (1)
- profxj (1)
- Ryantheshark84 (1)
- Amelia-T123 (1)
- akashsinghraghuvanshi (1)
- chrisdane (1)
Top Pull Request Authors
- damianobaldan (1)
- jbecherer (1)
- rwegener2 (1)
Top Issue Labels
Top Pull Request Labels
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 521 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 15
- Total maintainers: 1
pypi.org: mhw-detect
Fast marine heatwaves and extrem events detector based on https://github.com/ecjoliver/marineHeatWaves
- Homepage:
- Documentation: https://mhw-detect.readthedocs.io/
- Licenses: other
- Latest release: 0.2.4 (published over 1 year ago)
- Last Synced: 2025-04-26T13:32:23.632Z (1 day ago)
- Versions: 15
- Dependent Packages: 0
- Dependent Repositories: 1
- Downloads: 521 Last month
-
Rankings:
- Dependent packages count: 10.112%
- Average: 20.807%
- Dependent repos count: 21.571%
- Downloads: 30.737%
- Maintainers (1)
Dependencies
Score: 11.976609165471144