v0.79.0

v0.79.0 | 22 Aug 2024

This version introduces a histogram plot that has the option to display z-score as vertical lines superimposed on the
distribution, which helps in assessing z-score settings used by some outlier removal functions.

Histogram plot of half-hourly air temperature measurements at the ICOS Class 1 ecosystem
station Davos between 2013 and 2022, displayed in
20 equally-spaced bins. The dashed vertical lines show the z-score and the corresponding value calculated based on the
time series. The bin with most counts is highlighted orange.

New features

• Added new class HistogramPlotfor plotting histograms, based on the Matplotlib
  implementation (diive.core.plotting.histogram.HistogramPlot)
• Added function to calculate the value for a specific z-score, e.g., based on a time series it calculates the value
  where z-score = 3 etc. (diive.core.funcs.funcs.val_from_zscore)

Additions

• Added histogram plots to FlagBase, histograms are now shown for all outlier methods (diive.core.base.flagbase.FlagBase.defaultplot)
• Added daytime/nighttime histogram plots to (diive.pkgs.outlierdetection.hampel.HampelDaytimeNighttime)
• Added daytime/nighttime histogram plots to (diive.pkgs.outlierdetection.zscore.zScoreDaytimeNighttime)
• Added daytime/nighttime histogram plots to (diive.pkgs.outlierdetection.lof.LocalOutlierFactorDaytimeNighttime)
• Added daytime/nighttime histogram plots to (
  diive.pkgs.outlierdetection.absolutelimits.AbsoluteLimitsDaytimeNighttime)
• Added option to calculate the z-score with sign instead of absolute (diive.core.funcs.funcs.zscore)

Changes

• Improved daytime/nighttime outlier plot used by various outlier removal classes (
  diive.core.base.flagbase.FlagBase.plot_outlier_daytime_nighttime)

Notebooks

• Added notebook for plotting histograms (notebooks/Plotting/Histogram.ipynb)
• Added notebook for manual removal of data points (notebooks/OutlierDetection/ManualRemoval.ipynb)
• Added notebook for outlier detection using local outlier factor, separately during daytime and nighttime (
  notebooks/OutlierDetection/LocalOutlierFactorDaytimeNighttime.ipynb)
• Updated notebook (notebooks/OutlierDetection/HampelDaytimeNighttime.ipynb)
• Updated notebook (notebooks/OutlierDetection/AbsoluteLimitsDaytimeNighttime.ipynb)
• Updated notebook (notebooks/OutlierDetection/zScoreDaytimeNighttime.ipynb)
• Updated notebook (notebooks/OutlierDetection/LocalOutlierFactorAllData.ipynb)

Tests

• Added unittest for plotting histograms (tests.test_plots.TestPlots.test_histogram)
• Added unittest for calculating histograms (without plotting) (tests.test_analyses.TestCreateVar.test_histogram)

What's Changed

• v0.79.0 by @holukas in #176

Full Changelog: v0.78.1.1...v0.79.0