Changelog
=========

--------------

v2506.1.0 [2025-06-12]
----------------------

Changed:
~~~~~~~~

- | 🗓️ **Versioning format** to ``vYYMM.m.p``:
  | Release from year ``YY`` and month ``MM``, minor version ``m``,
    patch version ``p``

- | 🧼 **Code formatting & linting**
  | ✨ Reformatted and linted code base for consistency
  | 📦 MRs: !8, !9
  | 🆔 Commits: ``11388ba``, ``d57d449``

Update:
~~~~~~~

- 📝 **Natural-areas documentation**
  Clarified info in Sphinx and general docs
  📦 MRs: !6, !7
  🆔 Commits: ``48c246b``, ``afd99ec``

[2025-06-06]
------------

Feature
~~~~~~~

- | 🧩 **Multi-ensemble support**
  | Files are now filtered per ensemble using patterns like
    ``_{ensemble}_``, ``/{ensemble}/``, or suffix.
  | 🔁 Merged ``multi_ensemble`` into ``master`` (MR !5)
  | 🆔 Commit: ``475056b``

- | 🌾 **Ensemble-tagged output for CSI, HMD, SPEI**
  | Intermediate files are saved with ensemble suffix (``hmd_<ens>.nc``,
    etc.) for reuse.
  | 🆔 Commit: ``135a1e7``

.. _changed-1:

Changed
~~~~~~~

- | 🌾 **Sequential HMD → SPEI → CSI execution**
  | Safer for SLURM timeouts and crash recovery; better logging added.
  | 🆔 Commit: ``74c67c2``

- | 🧱 **Refactor plugin structure**
  | Separated ``processing``, ``spatial_utils``, and ``plotting`` logic.
  | Improved ``main()`` orchestration and logging format.
  | 🆔 Commits: ``f18a3a3``, ``ecaadbe``, ``901c833``

Fixed
~~~~~

- | 🧩 **Masking stability**
  | Fixed broadcasting issues; applied mask with ``where(mask == 1)``.
  | 🆔 Commits: ``7435b8c``, ``3c1f1c5``

- | 🧼 **Removed obsolete scripts and crop types**
  | Cleaned unused code, removed legacy crop entries.
  | 🆔 Commits: ``a901d85``, ``8186b55``, ``2406e7a``

- | 🧪 **Improved error handling and robustness**
  | Added traceback support, SPEI gamma fixes, and more informative
    errors.
  | 🆔 Commits: ``3aaf318``, ``2189a1e``, ``0a084a7``

--------------

[2025-05-28] — 🎉 First working plugin version
----------------------------------------------

This marks the **first functional release** of the CROPS plugin, with
core capabilities integrated and validated.

.. _feature-1:

Feature
~~~~~~~

- 🎞️ **Index animation output**
  Automatic generation of ``.mp4`` animations for CSI, HMD, and SPEI per
  ensemble.
  🆔 Commit: ``1525936``

.. _changed-2:

Changed
~~~~~~~

- | 🔁 **Dask-based processing**
  | CSI, SPEI, and HMD now run in delayed/lazy mode using Dask.
  | Enables efficient parallelism and memory use.
  | 🆔 Commits: ``80c4900``, ``81559d6``, ``f34409``, ``7cb76ee``

- | 🧱 **Spatial utilities refactor**
  | Introduced generalized coordinate handling and safe regridding
    logic.
  | 🆔 Commit: ``c48e981``

.. _fixed-1:

Fixed
~~~~~

- | 🧩 **Lon/lat mask issues resolved**
  | Dimension alignment in ``where(mask)`` operations now stable.
  | 🆔 Commit: ``3c1f1c5``

- | 🧼 **Removed unused logic and warnings**
  | Deleted legacy scripts, cleared redundant code, suppressed noisy
    warnings.
  | 🆔 Commits: ``8be7cc0``, ``994bda``

--------------