Changelog

All notable changes to the Climate Diagnostics Toolkit will be documented here.

Version 1.3.0 (2025-08-07)

Major Architectural Improvements

  • Complete Code Architecture Refactoring - Eliminated monolithic _select_data method and replaced with centralized select_process_data utility

  • Enhanced Exception Handling - Replaced broad exception catches with specific exception types (ValueError, TypeError, AttributeError) for better debugging

  • Critical Bug Fixes - Fixed double curly brace f-string formatting bug in TimeSeries module

  • Performance Optimization - Streamlined data selection pipeline with reduced redundancy and improved maintainability

  • Import Optimization - Cleaned up redundant local imports and implemented top-level import strategy

Enhanced Robustness

  • Production-Ready Quality - All modules now follow consistent error handling patterns

  • Improved Maintainability - Centralized utility functions reduce code duplication and technical debt

  • Better Error Messages - Specific exception types provide clearer debugging information

  • Consistent API - All accessor methods now use the same data selection and processing pipeline

Developer Experience

  • Cleaner Codebase - Eliminated technical debt and improved code organization

  • Better Code Documentation - Consistent patterns make the codebase more readable

  • Enhanced Debugging - Specific exception handling makes issue identification faster

  • Reduced Complexity - Simplified method signatures and data flow

Version 1.1.1 (2025-07-02)

Major Features

  • Sophisticated Disk-Aware Chunking Strategy - Advanced chunking utilities with memory optimization and disk-aware processing

  • Dynamic Chunk Calculator - Automatically optimizes chunks based on operation type and system resources

  • Performance Profiling - Built-in chunking analysis and optimization recommendations

  • Memory-Conscious Processing - Intelligent memory estimation and chunk size calculation

  • Operation-Specific Optimization - Tailored chunking for time series, spatial analysis, and trend calculations

Enhanced Features

  • Complete documentation overhaul with beautiful Furo theme

  • Enhanced plotting capabilities with Cartopy integration

  • Advanced time series decomposition methods with optimized chunking

  • Statistical significance testing for trends with spatial chunking

  • Advanced Dask integration for large dataset processing

  • Customizable plot styling options

Version 1.1.0 (2025-06-30)

Legacy Features

  • Basic documentation and plotting capabilities

  • Initial Cartopy integration

  • Basic time series decomposition methods

  • Initial statistical significance testing for trends

  • Basic Dask integration for large dataset processing

  • Basic plot styling options

Improvements

  • Better error handling and user feedback

  • Comprehensive API documentation

  • Improved performance for spatial calculations

  • Support for multiple coordinate systems

  • Responsive documentation design

Bug Fixes

  • Fixed coordinate handling for irregular grids

  • Resolved memory issues with large datasets

  • Corrected trend calculation edge cases

  • Fixed projection issues in polar regions

Documentation

  • New tutorial series for beginners

  • Advanced user guides and examples

  • Interactive code examples

  • Contributing guidelines and development setup

Version 1.0.0 (2025-01-01)

Initial Release

  • First public release of Climate Diagnostics Toolkit

  • Basic plotting functionality

  • Time series analysis tools

  • Trend calculation methods

  • Utility functions for climate data

Core Features

  • xarray accessor integration

  • Geographic visualization support

  • Statistical analysis tools

  • Climate index calculations

Release Notes

Upcoming Features (v1.2.0)

  • Machine learning integration for pattern detection

  • Web-based interactive plotting

  • Enhanced statistical diagnostics

  • Improved data format support

  • Performance optimizations

Long-term Roadmap

  • Real-time data processing capabilities

  • Climate model evaluation tools

  • Mobile-friendly documentation

  • Community plugin system

Release Schedule

We follow semantic versioning (SemVer) and aim for:

  • Major releases: Annually (breaking changes)

  • Minor releases: Quarterly (new features)

  • Patch releases: As needed (bug fixes)

Version Numbering

Our version numbers follow the format: MAJOR.MINOR.PATCH

  • MAJOR: Incompatible API changes

  • MINOR: New functionality (backwards compatible)

  • PATCH: Bug fixes (backwards compatible)

Migration Guides

Upgrading from v1.0.x to v1.1.x

No breaking changes! All v1.0 code should work without modification.

New Features Available:

# New in v1.1: Enhanced plotting options
fig = ds.climate_plots.plot_mean(
    variable="temperature",
    projection="Robinson",  # New projections
    significance_test=True,  # New feature
    colorbar_extend="both"   # Enhanced styling
)

Deprecated Features

  • old_plot_function() → Use plot_mean() instead

  • legacy_trend_calc() → Use calculate_spatial_trends() instead