diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 093f833..4b4ce41 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -13,5 +13,6 @@ Please tag them using `#`, e.g. `Fixed #42`. - [ ] New code follows the project's style. - [ ] New code is compatible with the 3-Clause BSD license. - [ ] CHANGELOG has been updated. -- [ ] AUTHORS has been updated. +- [ ] docs have been updated +- [ ] code authors have been updated in CITATION.cff. - [ ] Copyright years in module docstrings have been updated. diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index 43b80a1..0000000 --- a/AUTHORS +++ /dev/null @@ -1,3 +0,0 @@ -Scientific Developers: -- @fpavogt (Frédéric P.A. Vogt), frederic.vogt@meteoswiss.ch -- @regDaniel (Daniel Regenass), daniel.regenass@meteoswiss.ch diff --git a/CHANGELOG b/CHANGELOG index e077908..10faf4b 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -4,10 +4,14 @@ The format is inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [v2.1.1] +### Fixed: + - [regDaniel, 2024-09-04] Inconsitencies in contribution guidelines, authorship declaration and citation file. + +## [v2.1.0] ### Added: - - [regDaniel, 2024-10-28] Feature to calculate cloud base height with a subset of instruments only + - [regDaniel, 2024-08-28] Feature to calculate cloud base height with a subset of instruments only ### Fixed: - - [regDaniel, 2024-10-28] Incompatibility of scipy and statsmodels + - [regDaniel, 2024-08-28] Incompatibility of scipy and statsmodels ## [v2.0.0] ### Added: diff --git a/CITATION.cff b/CITATION.cff index d66f3c3..bdd86a7 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,6 +1,6 @@ cff-version: 1.2.0 -message: If ampycloud was useful for your research, please cite both the dedicated article (from preferred-citation) and the software itself. +message: If ampycloud was useful for your research, please cite both the dedicated article (https://doi.org/10.5194/amt-17-4891-2024) and the software itself. type: software authors: - family-names: Vogt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1488b6f..6602174 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,6 +42,11 @@ Please be sure to read (and understand the implications) of the ampycloud is being developed in a **public** repository under the [MeteoSwiss organization](https://github.com/MeteoSwiss/ampycloud) on Github. The documentation, generated using Sphinx, is hosted as Github Pages on the `gh-pages` branch of the repo, and is visible at https://MeteoSwiss.github.io/ampycloud. +### New developer + +Please make sure to read the instructions below carefully. In addition, please add your name to the software part of the [citation](#CITATION.cff) file at the latest before triggering +a [release](#release-mechanisms)(the top part defines the citation for the software, the bottom part defines the citation of the scientific article) and make sure to properly +update the CHANGELOG and the [documentation](#documentation) if necessary. ### Branching model @@ -226,8 +231,9 @@ You should of course feel free to use more of the tools offered by ### Documentation -There is a scientific article about the ampycloud **algorithm** in preparation. It will complement -the [Sphinx documentation](https://MeteoSwiss.github.io/ampycloud) that contains all the important elements required to use the ampycloud **Python package**. +There is a [scientific article](https://amt.copernicus.org/articles/17/4891/2024/) about the ampycloud **algorithm** v2.0.0. It complements +the [Sphinx documentation](https://MeteoSwiss.github.io/ampycloud) that contains all the important elements required to use the ampycloud **Python package**. Scientific changes +on top of version v2.0.0 must be added to [the corresponding section in the docs](https://meteoswiss.github.io/ampycloud/changes.html). The Sphinx documentation can be generated manually as follows: ``` diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 06e5b30..af1fd48 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -1,5 +1,7 @@ .. include:: ./substitutions.rst +.. _changelog: + Changelog ========= diff --git a/docs/source/changes.rst b/docs/source/changes.rst index 47ebc66..68c250c 100644 --- a/docs/source/changes.rst +++ b/docs/source/changes.rst @@ -9,7 +9,7 @@ The scientific documentation of Ampycloud v2.0.0 can be found `here `_. In this page, we list all changes since v.2.0.0 that go beyond bugfixing, refactoring, patching, etc. and have an impact on the science of the algorithm. More detailed -information on changes can be found in the `changelog `. +information on changes can be found in the :ref:`changelog `. v2.1.0: Enable ceilometer filtering for calculation of cloud base height @@ -18,11 +18,10 @@ v2.1.0: Enable ceilometer filtering for calculation of cloud base height There might be situations, where it is beneficial to calculate the cloud base height from a subset of ceilometer hits reported by specific ceilometers. For example: -- If the cloud height is supposed to be representative for a given location, but -you still want to use as many ceilometers as possible to infer the amount. -- If you use different ceilometer models and know that you want to calculate the -height only from hits of a specific ceilometer model to avoid implementing -complicated correction factors. + +- If the cloud height is supposed to be representative for a given location, but you still want to use as many ceilometers as possible to infer the amount. +- If you use different ceilometer models and know that you want to calculate the height only from hits of a specific ceilometer model to avoid implementing complicated correction factors. + To this end, the parameter ``EXCLUDE_FOR_BASE_HEIGHT_CALC`` was implemented in this version. The default value is an empty list. In order to activate the filtering, it is sufficient to enter the ceilometer IDs of the ceilos to exclude