Merge pull request #110 from MeteoSwiss/develop

Release v1.0.0
MeteoSwiss · Nov 14, 2023 · cffa163 · cffa163
2 parents 3019954 + 52d643f
commit cffa163
Show file tree

Hide file tree

Showing 24 changed files with 1,503 additions and 192 deletions.
diff --git a/.github/workflows/CI_pylinter.yml b/.github/workflows/CI_pylinter.yml
@@ -18,7 +18,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: ['3.11']
+        python-version: ['3.x']
 
     steps:
       # Checkout our repository

diff --git a/.github/workflows/CI_pytest_weekly.yml b/.github/workflows/CI_pytest_weekly.yml
@@ -20,7 +20,6 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        #python-version: # Use the latest Python version available for this test.
 
     steps:
     # Checkout the master branch from the repository
@@ -35,24 +34,8 @@ jobs:
     # Setup python
     - name: Set up Python
       uses: actions/setup-python@v4
-      #with:
-      #  python-version: ${{ matrix.python-version }}
-
-    # Check the python/conda setup (can be useful to diagnose bug with this Action)
-    # Powershell syntax adapted from:
-    # https://stackoverflow.com/questions/63805/equivalent-of-nix-which-command-in-powershell
-    # Answer from: petrsnd
-    - name: Check the setup (I)
-      if: matrix.os == 'windows-latest'
-      run: |
-        Get-Command python | Select-Object -ExpandProperty Definition
-        echo $CONDA
-
-    - name: Check the setup (II)
-      if: matrix.os != 'windows-latest'
-      run: |
-        which python
-        which conda
+      with:
+        python-version: '3.x'
 
     # Install all the dependencies we require
     - name: Install dependencies
@@ -64,7 +47,7 @@ jobs:
     - name: Install our module
       run: pip install -e .[dev]
 
-    # Read to run all the tests !
+    # Ready to run all the tests !
     - name: Run pytest
       run: |
         pytest -s
diff --git a/.github/workflows/pylinter.py b/.github/workflows/pylinter.py
@@ -71,7 +71,7 @@ def main():
         fn_list = [item for item in fn_list if bad_item not in item]
 
     # Launch pylint with the appropriate options
-    run = lint.Run(pylint_args + fn_list, do_exit=False)
+    run = lint.Run(pylint_args + fn_list, exit=False)
     # Collect the total score
     score = run.linter.stats.global_note
 

diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,7 @@ dist/
 eggs/
 *.egg-info/
 docs/source/modules/
+.venv/
 
 # MacOS stuff
 *.DS_Store

diff --git a/AUTHORS b/AUTHORS
@@ -1,2 +1,3 @@
 Scientific Developers:
 - @fpavogt (Frédéric P.A. Vogt), [email protected]
+- @regDaniel (Daniel Regenass), [email protected]
diff --git a/CHANGELOG b/CHANGELOG
@@ -3,6 +3,15 @@ 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
+ - [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:
@@ -27,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
@@ -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