Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v1.0.0 #110

Merged
merged 34 commits into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
34e7956
Fix pytest-weekly Action script
fpavogt Oct 5, 2023
b067a10
Fix pylint Action for pylint 3.x
fpavogt Oct 5, 2023
2a5fbef
Merge pull request #106 from MeteoSwiss/develop_vof
fpavogt Oct 5, 2023
e00838f
Misc doc update for v1.0.0
fpavogt Nov 9, 2023
9011e29
Merge pull request #109 from MeteoSwiss/develop_vof
fpavogt Nov 14, 2023
2e29c4d
Fix pytest-weekly Action script
fpavogt Oct 5, 2023
c391dd0
Fix pylint Action for pylint 3.x
fpavogt Oct 5, 2023
7d1fc02
AMAROC-681 add test cases for bug
regDaniel Nov 9, 2023
88616c1
AMAROC-681 introduce min sep to grouping step
regDaniel Nov 9, 2023
820149d
AMAROC-681 change layer sep dist to alt_base
regDaniel Nov 9, 2023
fe598c6
AMAROC-681 handle empty array in cloud base calc
regDaniel Nov 9, 2023
082486c
AMAROC-681 catch GMM test corner case
regDaniel Nov 10, 2023
452790d
AMAROC-681 edit CHANGELOG
regDaniel Nov 10, 2023
622abb4
AMAROC-681 refactor (split) metarize function
regDaniel Nov 10, 2023
04ea751
AMAROC-681 remove obsolete calculation step
regDaniel Nov 10, 2023
a5c3ea6
AMAROC-681 add group sep test
regDaniel Nov 13, 2023
6282348
AMAROC-681 remove obsolete return statement
regDaniel Nov 13, 2023
53ead18
AMAROC-681 type annotations & docstrings
regDaniel Nov 13, 2023
4fc51ae
AMAROC-681 fix typo
regDaniel Nov 13, 2023
775c642
AMAROC-681 remove index column from test data
regDaniel Nov 13, 2023
95f335a
AMAROC-681 add .venv/ to .gitignore
regDaniel Nov 13, 2023
a75b711
AMAROC-681 unify docstring layout.
regDaniel Nov 13, 2023
0dbcaea
AMAROC-681 apply suggestions from code review
regDaniel Nov 14, 2023
ceb7668
AMAROC-681 type hints fixes + renaming
regDaniel Nov 14, 2023
4534fc0
AMAROC-681 fix and refactor cloud base alt calc
regDaniel Nov 14, 2023
cfac51b
AMAROC-681 add verbose comment for indexing
regDaniel Nov 14, 2023
6f7b712
AMAROC-681 test for multiple group overlaps
regDaniel Nov 14, 2023
c38a643
AMAROC-681 rename original_id - cluster_id
regDaniel Nov 14, 2023
4cb25fe
Merge branch 'develop' into bugfix/AMAROC-681-double-layers
regDaniel Nov 14, 2023
de08dc5
AMAROC-681 fix typos + co from code review
regDaniel Nov 14, 2023
84eae3d
AMAROC-681 rename cover - amount
regDaniel Nov 14, 2023
9474db9
AMAROC-681 fix pylint issues
regDaniel Nov 14, 2023
2d6662d
AMAROC-681 update AUTHORS file
regDaniel Nov 14, 2023
52d643f
Merge pull request #108 from MeteoSwiss/bugfix/AMAROC-681-double-layers
regDaniel Nov 14, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/CI_pylinter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
python-version: ['3.11']
python-version: ['3.x']

steps:
# Checkout our repository
Expand Down
23 changes: 3 additions & 20 deletions .github/workflows/CI_pytest_weekly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
2 changes: 1 addition & 1 deletion .github/workflows/pylinter.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ dist/
eggs/
*.egg-info/
docs/source/modules/
.venv/

# MacOS stuff
*.DS_Store
Expand Down
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Scientific Developers:
- @fpavogt (Frédéric P.A. Vogt), [email protected]
- @regDaniel (Daniel Regenass), [email protected]
12 changes: 9 additions & 3 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
3 changes: 2 additions & 1 deletion docs/source/acknowledge.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.. include:: ./substitutions.rst

Acknowledging ampycloud
=======================
Expand All @@ -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:

Expand Down
10 changes: 0 additions & 10 deletions docs/source/doc_todo.rst

This file was deleted.

17 changes: 5 additions & 12 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -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
--------------------------------------
Expand Down Expand Up @@ -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
5 changes: 4 additions & 1 deletion docs/source/substitutions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading