diff --git a/CHANGELOG b/CHANGELOG index ff7c7d7..1c1a1b7 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -3,14 +3,16 @@ 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). -## [v0.7.0] +## [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. @@ -34,9 +36,6 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm - [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. -### Deprecated: -### Removed: -### Security: ## [v0.5.0.dev0] ### Fixed: diff --git a/README.md b/README.md index d75c22e..cd33d24 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # ampycloud +[![DOI](https://zenodo.org/badge/435391098.svg)](https://zenodo.org/doi/10.5281/zenodo.8399683) [![github](https://img.shields.io/github/release/MeteoSwiss/ampycloud.svg)](https://github.com/MeteoSwiss/ampycloud/releases) [![last-commit](https://img.shields.io/github/last-commit/MeteoSwiss/ampycloud.svg?colorB=e6c000)](https://github.com/MeteoSwiss/ampycloud) [![issues](https://img.shields.io/github/issues/MeteoSwiss/ampycloud.svg?colorB=b4001e)](https://github.com/MeteoSwiss/ampycloud/issues) diff --git a/docs/source/acknowledge.rst b/docs/source/acknowledge.rst index 7da84dc..b3585c4 100644 --- a/docs/source/acknowledge.rst +++ b/docs/source/acknowledge.rst @@ -1,3 +1,4 @@ +.. include:: ./substitutions.rst Acknowledging ampycloud ======================= @@ -6,7 +7,7 @@ Acknowledging ampycloud Ideally, you should also include the Digital Object Identifier (DOI) associated to the specific release you have been using: - ampycloud |version| (DOI:) + ampycloud |version| |doi| 2. If ampycloud was useful for your research, please cite the dedicated article: diff --git a/docs/source/doc_todo.rst b/docs/source/doc_todo.rst deleted file mode 100644 index f1a68f2..0000000 --- a/docs/source/doc_todo.rst +++ /dev/null @@ -1,10 +0,0 @@ - -TODO list -========= - -What follows is a list of all the ``TODO`` left in the docs and the code. - - - - -.. todolist:: diff --git a/docs/source/index.rst b/docs/source/index.rst index f2c5067..4c68246 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,16 +1,10 @@ .. include:: ./substitutions.rst -ampycloud |version| |stars| |watch| -=================================== - -|copyright| |license| |github| |pypi| |last-commit| |issues| |pytest-weekly| - -.. todo:: - - Tags for the latest DOI should be added when releasing the code - for the first time. These should also be added to the :ref:`acknowledge:Acknowledging ampycloud` - page. +ampycloud |version| |stars| |watch| |doi| +========================================= +|copyright| |license| +|pypi| |last-commit| |issues| |pytest-weekly| .. _fig-demo: .. figure:: ./examples/ampycloud_canonical_mock_demo.png @@ -18,7 +12,7 @@ ampycloud |version| |stars| |watch| :align: center :alt: ampycloud demo diagnostic diagram - the ampycloud diagnostic diagram for its canonical mock dataset. + The ampycloud diagnostic diagram for its canonical mock dataset. Welcome to the ampycloud documentation -------------------------------------- @@ -65,4 +59,3 @@ Table of contents Contributing Github repository modules - doc_todo diff --git a/docs/source/substitutions.rst b/docs/source/substitutions.rst index 58bf64b..e4d27da 100644 --- a/docs/source/substitutions.rst +++ b/docs/source/substitutions.rst @@ -24,4 +24,7 @@ :target: https://www.meteoswiss.admin.ch .. |pytest-weekly| image:: https://github.com/MeteoSwiss/ampycloud/actions/workflows/CI_pytest_weekly.yml/badge.svg - :target: https://github.com/MeteoSwiss/ampycloud/actions/workflows/CI_pytest_weekly.yml \ No newline at end of file + :target: https://github.com/MeteoSwiss/ampycloud/actions/workflows/CI_pytest_weekly.yml + +.. |doi| image:: https://zenodo.org/badge/435391098.svg + :target: https://zenodo.org/doi/10.5281/zenodo.8399683 \ No newline at end of file diff --git a/src/ampycloud/version.py b/src/ampycloud/version.py index 3ce5fb1..8b104d3 100644 --- a/src/ampycloud/version.py +++ b/src/ampycloud/version.py @@ -9,4 +9,4 @@ """ #:str: the one-and-only place where the ampycloud version is set. -VERSION = '0.6.0.dev0' +VERSION = '1.0.0' diff --git a/test/ampycloud/ref_data/README b/test/ampycloud/ref_data/README index 0bdbdc6..19e6222 100644 --- a/test/ampycloud/ref_data/README +++ b/test/ampycloud/ref_data/README @@ -10,7 +10,7 @@ or alternatively, to set a specific MSA value: geoloc_YYYY.MMM.DD-hh.mm.ss_ref-metar_MSAXXXXX.pkl -Each file is required to be a Python binary pickle, containing data ready to be fed to +Each file is required to be a CSV ASCII, containing data ready to be fed to ampycloud.run(), together with the geoloc and ref_dt extracted from the filename. Simply adding a file to this folder is sufficient to have it processed by the ampycloud test suite.