Changelog

The ampycloud changelog (reproduced below) is stored in the code repository on Github.

All notable changes to ampycloud will be documented in this file.

The format is inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [v2.1.1]
### Fixed:
 - [regDaniel, 2024-09-19] Require statsmodels >= v0.14.3, where incompatibility with scipy is fixed
 - [regDaniel, 2024-09-04] Inconsitencies in contribution guidelines, authorship declaration and citation file.

## [v2.1.0]
### Added:
 - [regDaniel, 2024-08-28] Feature to calculate cloud base height with a subset of instruments only
### Fixed:
 - [regDaniel, 2024-08-28] Incompatibility of scipy and statsmodels

## [v2.0.0]
### Added:
 - [fpavogt, 2024-06-26] Add ability to trigger weekly tests manually.
 - [fpavogt, 2024-04-16] Improve input data consistency check (fix #116).
 - [regDaniel, 2024-04-09] Add flag for clouds above (MSA + MSA_HIT_BUFFER) and allow for NSC in METAR message.
 - [fpavogt, 2024-03-26] Add option to reset only a single parameter.
### Fixed:
 - [srethore, 2024-04-23] Fix static types issues.
 - [regDaniel, 2024-04-23] Fix deprecated github actions worklflow file
 - [fpavogt, 2024-04-17] Fix #119
 - [regDaniel, 2024-04-09] Minor adaptions to better comply with PEP standards.
 - [fpavogt, 2024-03-26] Use "height" in "ft aal" throughout.
### Changed:
 - [fpavogt, 2024-06-25] Add support for numpy >2.0
 - [fpavogt, 2024-04-28] Add a rogue point to the mock example.
 - [fpavogt, 2024-03-25] Set the fluffiness boost to 2 (fixes #123).
 - [fpavogt, 2024-03-23] Changed default mock dataset to be 900s long (instead of 2400s).

## [v1.0.0]
### Added:
 - [regDaniel, 2023-11-09] Add minimum separation condition for grouping step.
### Fixed:
 - [regDaniel, 2023-11-09] Fix #107 (no more reporting of two layers at same height).
### Changed:
- [fpavogt, 2023-11-05] Updated version to 1.0.0 for first full release, incl. misc documentation changes.
- [regDaniel, 2023-11-09] Changed min sep in layering from layer mean to layer base altitude.
- [regDaniel, 2023-11-10] Refactoring (modularization) of metarize method.

## [v0.6.0.dev0]
### Added:
 - [fpavogt, 2022-10-19] Add scipy to the list of required dependencies.
 - [fpavogt, 2022-10-19] The metarize routine now also computes the "fluffiness" of cloud layers.
 - [fpavogt, 2022-10-18] Add option to use a percentage of the most recent measurements to derive the base altitude.
 - [fpavogt, 2022-10-18] Add 3 new scientific validation cases.
### Fixed:
 - [fpavogt, 2023-08-11] Fix #18 (all matplotlib params are now strictly set in context).
 - [fpavogt, 2023-07-07] Fix #95 (pylint 3.0 deprecation of epylinter).
 - [fpavogt, 2023-07-03] Fix #98 (pkg_resources -> packaging in test_version.py).
 - [fpavogt, 2022-10-18] Fix #84 and #85.
### Changed:
 - [fpavogt, 2023-07-26] Require layers to be at least 250ft appart before splitting a group.
 - [fpavogt, 2023-07-13] Deployment of the new Issue form in YAML format (fixes #93).
 - [fpavogt, 2023-07-07] Demo datasets are now stored as csv and not pkl (fixes #102).
 - [fpavogt, 2022-12-16] Replace OKTA_LIM0 (OKTA_LIM8) with MIN_HITS_OKTA0 (MAX_HOLES_OKTA8) - fixes #92.
 - [fpavogt, 2022-10-20] Remove superfluous parameters from the default set.
 - [fpavogt, 2022-10-18] Fluffiness is now computed via LOWESS instead of a Convex Hull.
 - [fpavogt, 2022-10-18] Base level is now defined as a percentile of the total number of points.
 - [fpavogt, 2022-10-18] Enable multiple min_sep_vals for the LAYERING step.
 - [fpavogt, 2022-10-18] Cleanup pylint and error messages.
 - [fpavogt, 2022-10-18] Use min/max+padding to assess if slices are overlapping, instead of mean+std.
 - [fpavogt, 2022-10-18] Default value of OKTA_LIM8 is changed from 98 to 99.

## [v0.5.0.dev0]
### Fixed:
 - [fpavogt, 2022-07-08] Fix #78 and #79.

## [v0.4.0.dev0]
### Added:
 - [fpavogt, 2022-02-27] Add new speed-check Action.
 - [fpavogt, 2022-02-25] Add the `prms` keyword to set parameters for each run call in a thread-safe manner.
### Fixed:
 - [fpavogt, 2022-03-02] Fix #75.
 - [fpavogt, 2022-02-25] Fix #71 and #25.
### Removed:
 - [fpavogt, 2022-02-25] Remove yaconfigobject dependency in favor of ruamel.yaml.
### Security:

## [v0.3.0.dev0]
### Added:
 - [fpavogt, 2022-01-27] Add tests for the .plots.secondary module.
### Fixed:
 - [fpavogt, 2022-01-27] Fix #66 and #67.
 - [fpavogt, 2022-01-26] Fix #62, #63 and #64.
### Changed:
 - [fpavogt, 2022-02-01] Implement review feedback, including name change for `scaled` to `apply_scaling`.

## [v0.2.1.dev0]
### Fixed:
 - [fpavogt, 2022-01-21] Fix #58.

## [v0.2.0.dev1]
### Fixed:
 - [fpavogt, 2022-01-21] First pypi release.

## [v0.2.0.dev0]
### Added:
 - [fpavogt, 2022-01-21] New CI Actions to automate the pypi releases.
 - [fpavogt, 2022-01-17] Added new utils.utils.temp_seed() function to set random seed temporarily only.
 - [fpavogt, 2022-01-13] New icao module, for easy/clean access to the significant_cloud() function.
 - [fpavogt, 2022-01-13] Doc cleanup/improvement, and use of :py:func: (etc...) function to ease user navigation.
### Fixed:
 - [fpavogt, 2022-01-17] Fix #49 - mock cloud layers now have proper type values.
 - [fpavogt, 2022-01-10] Fix issues #40 and #41.
### Changed:
 - [fpavogt, 2022-01-14] Fix #47.
 - [fpavogt, 2022-01-10] Update copyright years.
### Deprecated:
### Removed:
 - [fpavogt, 2022-01-14] ampycloud.core.synop(), and all synop references.
### Security:

## [v0.1.0]
### Added:
 - [fpavogt, 2021-12-21] Add tests to check real data for scientific stability (fixes #33).
 - [fpavogt, 2021-12-17] Add CODE_OF_CONDUCT.md and auto-doc-publish action, incl. first doc release.
 - [fpavogt, 2021-12-16] Add a new entry point for `copy_prm_file`, i.e. fix #26.
 - [fpavogt, 2021-12-15] Add `msa` to `plots.diagnostic`, i.e. fix #22.
 - [fpavogt, 2021-12-10] Add Minimum Sector Altitude to the metar_msg() method.
 - [fpavogt, 2021-12-10] Add detailed examples to the core functions, and link them in the doc.
 - [fpavogt, 2021-12-10] Add the performance module, and a dedicated high level entry point.
 - [fpavogt, 2021-12-10] Improve plots with show, save, close methods, and tweak their look.
 - [fpavogt, 2021-12-10] Add pytest ficture to let users feed 'MPL_STYLE' as a command line argument
 - [fpavogt, 2021-12-09] Add the plots module.
 - [fpavogt, 2021-12-08] Add the MANIFEST.in file, to include parameter and plot style files.
 - [fpavogt, 2021-12-08] Add the data, dynamic, and core modules, and a new AmpycloudWarning class.
 - [fpavogt, 2021-12-07] Add the wmo, scaler, layer, cluster, and utils.mocker modules.
 - [fpavogt, 2021-12-07] Add the AmpycloudError class.
 - [fpavogt, 2021-12-06] Setup logging tools, incl. custom decorator for fcts.
 - [fpavogt, 2021-12-06] Setup docs, including instructions and a CI/CD "check" Action.
 - [fpavogt, 2021-12-06] Initial Github upload, incl. CI/CD actions, package & test infrastructure.
### Fixed:
 - [fpavogt, 2021-12-23] Fix warning when plotting empty chunks, and correctly handle single points.
 - [fpavogt, 2021-12-20] Fix #30 and #31.
 - [fpavogt, 2021-12-15] Fix bug in `CeiloChunk.metar_msg()` when all clouds are above the MSA.
 - [fpavogt, 2021-12-12] Fix the format_slices() method of the DiagnosticPlot class.
 - [fpavogt, 2021-12-09] Fix #5.
 - [fpavogt, 2021-12-08] Fix #14.
### Changed:
 - [fpavogt, 2021-12-24] Small doc cleanup, and "release" of v0.1.0.
 - [fpavogt, 2021-12-21] Add MSA and MSA_HIT_BUFFER parameters (fixes #34).
 - [fpavgot, 2021-12-20] Implement feedback from @loforest.
 - [fpavogt, 2021-12-17] Improve the handling of the optional requirements.
 - [fpavogt, 2021-12-17] Minor fixes following reviews by loforest.
 - [fpavogt, 2021-12-16] Change the approach of the dynamic module to exploit yaconfigobject (fixes #24).
 - [fpavogt, 2021-12-08] Change `mock_layer` to return a pd.DataFrame instead of a np.ndarray.
### Deprecated:
### Removed:
### Security: