Misc doc update for v1.0.0

MeteoSwiss · Nov 9, 2023 · e00838f · e00838f
1 parent b067a10
commit e00838f
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 29 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -3,6 +3,14 @@ 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).
 
+## [v1.0.0]
+### Added:
+### Fixed:
+### Changed:
+ - [fpavogt, 2023-11-05] Updated version to 1.0.0 for first full release, incl. misc documentation changes.
+### Deprecated:
+### Removed:
+### Security:
 
 ## [v0.6.0.dev0]
 ### Added:
@@ -27,9 +35,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
@@ -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
@@ -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
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,24 +1,18 @@
 
 .. 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
     :width: 750px
     :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 <https://github.com/MeteoSwiss/ampycloud/blob/develop/CONTRIBUTING.md>
     Github repository <https://github.com/MeteoSwiss/ampycloud>
     modules
-    doc_todo
diff --git 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
+   :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
diff --git 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
@@ -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.