(releasnotes)=
# Release Notes

This page summarizes the major changes and features provided in each release.


## Version 1.2 (January 2026)

This version expanded digger in the following ways:
- The method [`analyze.ellipse`](#digger.analyze.ellipse.ellipse) was added to the [`analyze`](#digger.analyze) submodule and existing methods were improved.
- The method [`compare.deposit`](#digger.compare.deposit.rmse) was added to the [`compare`](#digger.compare) submodule.
- Four new methods were added to the [`make`](#digger.make) submodule
  ([`make.breach`](#digger.make.breach.breach), [`make.interpolation`](#digger.make.interpolation.interpolation), [`make.lake`](#digger.make.lake.lake), and
  [`make.polyhedron`](#digger.make.polyhedron.polyhedron)).
- The utilities and plotting methods were expanded to support the new features.
- Where identified, bugs in existing methods were fixed.
- Examples and tests were added or expanded.
- Packaging, distribution, and developer tools were improved.

## Version 1.1 (December 2024)

This version expanded digger in the following ways:
- The [`analyze`](#digger.analyze) submodule was added to provide five methods for analyzing runout simulation output ([`analyze.energetics`](#digger.analyze.energetics.energetics), [`analyze.spectrogram`](#digger.analyze.spectrogram.spectrogram), [`analyze.splash`](#digger.analyze.splash_points.splash), [`analyze.wavelet`](#digger.analyze.wavelet.wavelet), [`analyze.where_landslide_went`](#digger.analyze.where_landslide_went.where_landslide_went)).
- The method [`compare.confusion`](#digger.compare.confusion) was added to the [`compare`](#digger.compare) submodule was added to enable comparison of runout simulation output and observations.
- The [`make`](#digger.make) submodule was expanded to include two new methods to generate initial conditions for landslide runout simulations ([`make.new_water`](#digger.make.new_water.new_water) and [`make.reservoir`](#digger.make.reservoir.reservoir)). Additionally, the existing methods were improved.
- The utilities and plotting methods were expanded to support the new features.
- Where identified, bugs in existing methods were fixed.
- Examples and tests were added or expanded.
- Packaging, distribution, and developer tools were improved.

## Version 1.0 (November 2023)

The initial version of digger contained three methods in the [`make`](#digger.make) submodule used for geometric estimation of lanslide failure surfaces and generate files used for landslide runout modeling ([`make.scoops`](#digger.make.scoops.scoops), [`make.slabs`](#digger.make.slabs.slabs) and [`make.entrainment`](#digger.make.entrainment.entrainment)). This version also provided a number of utility and plotting features.