HDP Release v1.0.2

Features and Improvements ✨

• Added sample data functions
• Added Dockerfile for testing and development
• Expanded unit testing to include full workflow
• Updated Quick Start to be fully reproducible
• Updated JOSS paper figure to be fully reproducible

Bug Fixes 🐛

• Fixed issue with xarray chunk mapping
• Fixed local environment when building documentation

Known Issues🔍

• Unit testing throws warning related to deprecated xarray function
• Unit testing throws warning due to missing downloaded asset

Future Work 📅

• Write up a detailed contribution guide

HDP Release v1.0.1

Bug Fixes 🐛

• Fixed heat_index runtime warning due to invalid values
• Fixed error in pyproject.toml with package versioning on PyPI

Future Work 📅

• More testing on different computing systems and input datasets is needed to ensure portability and compatibility
• Expand the user guide
• Build a Command Line Interface
• Add figures for measures and thresholds
• Finish unit testing for all computational functions

HDP Release v1.0.0

Features and Improvements ✨

• Complete workflow for computing heatwave metrics across multiple thresholds and definitions
• Added new heatwave metrics: HWN and HWA
• Designed graphics module with template figures and notebook functionality
• Added rich metadata including history attribute to track changes made to data
• Added heat index implementation
• Major reduction in memory use by optimizing task graph
• Added documented User Guide and API available on ReadTheDocs
• Added automated unit testing for core functionality such as metric calculation and dataset handling
• Implemented modular software design for easier expansion and developer-friendly API
• Added matplotlib style sheet for use within the HDP and by the Persad Aero-Climate Lab

Bug Fixes 🐛

• Fixed issue with seasonal ranges being inconsistent
• Fixed unit handling issues, can convert between units and will raise error if unknown units are detected
• Fixed excessive task-graphs being submitted to the dask cluster

Known Issues🔍

• heat_index throws a floating point warning due to issues with NaN handling

Future Work 📅

• More testing on different computing systems and input datasets is needed to ensure portability and compatibility
• The user guide is a work in progress
• Still need to build a Command Line Interface
• The graphics module has figures for only heatwave metrics, future work will include adding figures for measures and thresholds
• Some functions need further documentation

HDP Release v0.1.0

Features and Improvements ✨

• Package can be installed using PyPI
• Preliminary unit tests
• Integrated github workflow for releasing versions
• Renamed repository to HDP acronym

Bug Fixes 🐛

• Fixed error packaging backend by switching to setuptools
• Fixed typo in classifiers field
• Fixed naming error in package name field