ampycloud 2.1.0__tar.gz → 2.2.0__tar.gz

{ampycloud-2.1.0 → ampycloud-2.2.0}/AUTHORS

@@ -1,3 +1,3 @@
-Scientific Developers:
 - @fpavogt (Frédéric P.A. Vogt), frederic.vogt@meteoswiss.ch
 - @regDaniel (Daniel Regenass), daniel.regenass@meteoswiss.ch
+- @srethore (Sophie Réthoré), sophie.rethore@meteoswiss.ch

{ampycloud-2.1.0 → ampycloud-2.2.0}/CHANGELOG

@@ -3,11 +3,21 @@ 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).
 
+## [v2.2.0]
+### Added:
+ - [srethore, 2026-09-01] Refactor pypi action using trusted publishing
+ and apply Open Source MCH template to the whole project.
+
 ## [v2.1.1]
+### Fixed:
+ - [regDaniel, 2024-09-19] Require statsmodels >= v0.14.3, where incompatibility with scipy is 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:

{ampycloud-2.1.0 → ampycloud-2.2.0}/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2021-2023 MeteoSwiss, contributors listed under AUTHORS
+Copyright 2021-2026 MeteoSwiss, contributors listed under AUTHORS
 
 Redistribution and use in source and binary forms, with or without modification, are permitted
 provided that the following conditions are met:

{ampycloud-2.1.0/src/ampycloud.egg-info → ampycloud-2.2.0}/PKG-INFO

@@ -1,27 +1,29 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ampycloud
-Version: 2.1.0
-Summary: Determining the sky coverage fraction and base height of cloud layers usingceilometer data
-Home-page: https://meteoswiss.github.io/ampycloud
-Author: Frédéric P.A. Vogt, Daniel Regenass
+Version: 2.2.0
+Summary: Determining the sky coverage fraction and base height of cloud layers using ceilometer data
+License-Expression: BSD-3-Clause
+License-File: AUTHORS
+License-File: LICENSE
+Author: Frédéric P.A. Vogt
 Author-email: frederic.vogt@meteoswiss.ch
-License: BSD-3-Clause
-Project-URL: Source, https://github.com/MeteoSwiss/ampycloud/
-Project-URL: Changelog, https://meteoswiss.github.io/ampycloud/changelog.html
-Project-URL: Issues, https://github.com/MeteoSwiss/ampycloud/issues
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Science/Research
-Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.9
+Requires-Python: >=3.10,<3.13
+Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.9.0
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: matplotlib (>=3.7.2)
+Requires-Dist: numpy (>=1.20.3)
+Requires-Dist: pandas (>=1.5)
+Requires-Dist: pyyaml
+Requires-Dist: ruamel.yaml
+Requires-Dist: scikit-learn (>=1.2.0)
+Requires-Dist: scipy (>=1.7.3)
+Requires-Dist: statsmodels (>=0.14.3)
+Project-URL: Changelog, https://meteoswiss.github.io/ampycloud/changelog.html
+Project-URL: Issues, https://github.com/MeteoSwiss/ampycloud/issues
+Project-URL: Source, https://github.com/MeteoSwiss/ampycloud/
 Description-Content-Type: text/markdown
-Provides-Extra: dev
-License-File: LICENSE
-License-File: AUTHORS
 
 # ampycloud
 
@@ -42,8 +44,9 @@ For the full documentation, installation instructions, etc ..., go to: https://m
 
 ### License & Copyright
 
-ampycloud is released under the terms of **the 3-Clause BSD license**. The copyright (2021-2024) belongs to MeteoSwiss.
+ampycloud is released under the terms of **the 3-Clause BSD license**. The copyright (2021-2026) belongs to MeteoSwiss.
 
 ### Contributing to ampycloud
 
 Please see the [contributing guidelines](CONTRIBUTING.md) for details.
+

{ampycloud-2.1.0 → ampycloud-2.2.0}/README.md

@@ -17,7 +17,7 @@ For the full documentation, installation instructions, etc ..., go to: https://m
 
 ### License & Copyright
 
-ampycloud is released under the terms of **the 3-Clause BSD license**. The copyright (2021-2024) belongs to MeteoSwiss.
+ampycloud is released under the terms of **the 3-Clause BSD license**. The copyright (2021-2026) belongs to MeteoSwiss.
 
 ### Contributing to ampycloud
 

ampycloud-2.2.0/pyproject.toml

@@ -0,0 +1,99 @@
+[project]
+dynamic = ["version"]
+name = "ampycloud"
+description = "Determining the sky coverage fraction and base height of cloud layers using ceilometer data"
+license = "BSD-3-Clause"
+readme = "README.md"
+authors = [
+    { name = "Frédéric P.A. Vogt", email = "frederic.vogt@meteoswiss.ch" },
+    { name = "Daniel Regenass" },
+]
+requires-python = ">=3.10,<3.13"
+dependencies = [
+    "matplotlib>=3.7.2",
+    "numpy>=1.20.3",
+    "scikit-learn>=1.2.0",
+    "scipy>=1.7.3",
+    "statsmodels>=0.14.3",
+    "pandas>=1.5",
+    "pyyaml",
+    "ruamel.yaml",
+]
+
+[project.urls]
+Source = "https://github.com/MeteoSwiss/ampycloud/"
+Changelog = "https://meteoswiss.github.io/ampycloud/changelog.html"
+Issues = "https://github.com/MeteoSwiss/ampycloud/issues"
+
+[project.scripts]
+ampycloud_speed_test = "ampycloud.__main__:ampycloud_speed_test"
+ampycloud_copy_prm_file = "ampycloud.__main__:ampycloud_copy_prm_file"
+
+[dependency-groups]
+test = [
+    "pytest (>=8.4.2,<9.0.0)",
+    "pytest-cov (>=7.0.0,<8.0.0)"
+]
+lint = [
+    "mypy (>=1.18.1,<2.0.0)",
+    "pylint (>=3.3.8,<4.0.0)",
+    "ruff (>=0.15.15,<0.16.0)",
+]
+doc = [
+    "pydata-sphinx-theme (>=0.16.1,<0.17.0)",
+    "sphinx (>=8.1.0,<8.2.0)",  # sphinx 8.2 raised the floor to Python 3.11, dropping 3.10 support
+    "sphinx-autoapi (>=3.6.0,<4.0.0)"
+]
+dev = [
+    { include-group = "test" },
+    { include-group = "lint" },
+    { include-group = "doc" }
+]
+
+[tool.poetry]
+requires-poetry = ">=2.0,<3.0"
+version = "2.2.0"  # DO NOT SET. The version of the package is always set by the CI/CD pipeline.
+packages = [{ include = "ampycloud", from = "src" }]
+include = [
+    "CHANGELOG",
+    "src/ampycloud/prms/*.yml",
+    "src/ampycloud/plots/mpl_styles/*.mplstyle",
+]
+
+[tool.pylint.master]
+disable = [
+    'C0114', # missing-module-docstring
+    'C0115', # missing-class-docstring
+    'C0116', # missing-function-docstring
+    'R0801', # duplications are already covered by SonarQube
+    'W0511', # fix me or to-do comments are already covered by SonarQube
+]
+
+[tool.pylint.basic]
+argument-naming-style = 'any'
+attr-naming-style = 'any'
+max-args = 8
+max-positional-arguments = 8
+good-names = ['_', 'a', 'ax', 'b', 'c', 'dt', 'f', 'fn', 'i', 'j', 'k', 'w', 'x', 'y', 'z']
+
+[tool.pylint.format]
+# Maximum number of lines in a module.
+max-line-length = 120
+
+[tool.pylint.design]
+# Minimum number of public methods for a class (see R0903).
+min-public-methods = 0
+
+[tool.mypy]
+ignore_missing_imports = true
+disallow_untyped_defs = true
+
+[tool.coverage.run]
+omit = ["test/**", "doc/**"]
+
+[tool.ruff]
+line-length = 120
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

ampycloud-2.2.0/src/ampycloud/__main__.py

@@ -0,0 +1,90 @@
+"""
+Copyright (c) 2021-2026 MeteoSwiss, contributors listed in AUTHORS.
+
+Distributed under the terms of the 3-Clause BSD License.
+
+SPDX-License-Identifier: BSD-3-Clause
+
+Module contains: high-level entry point routines
+"""
+
+# Import from Python
+import argparse
+import platform
+import multiprocessing as mp
+from datetime import datetime
+
+# Import from ampycloud
+from .version import VERSION
+from .utils import performance
+from .core import copy_prm_file
+
+
+def ampycloud_speed_test() -> None:
+    """The ampycloud_speed_test entry point, meant to by launched from the command line."""
+
+    # Use argparse to make ampycloud user friendly
+    parser = argparse.ArgumentParser(
+        description=f"ampycloud {VERSION}"
+        + " - Python package to characterize cloud layers"
+        + " using ceilometer measurements.\n"
+        + "This entry point lets you measure the performance of ampycloud on your machine.",
+        epilog="For details: https://MeteoSwiss.github.io/ampycloud\n ",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+
+    parser.add_argument(
+        "-niter",
+        action="store",
+        default=10,
+        type=int,
+        metavar="int",
+        help="Number of ampycloud.demo() executions to trigger. Defaults to 10.",
+    )
+
+    # Done getting ready. Now start doing stuff.
+    # What did the user type in ?
+    args = parser.parse_args()
+
+    # Launch the initialization of a new processing arena
+    niter, mean, std, median, mmin, mmax = performance.get_speed_benchmark(niter=args.niter)
+
+    print(f"\nTest datetime: {datetime.now()}")
+    print(f"Platform: {platform.platform()}")
+    print(f"CPU count: {mp.cpu_count()}\n")
+
+    print(f"ampycloud.demo() execution time from {niter} runs:")
+    print(f" * mean [std]: {mean:.2f}s [{std:.2f}s]")
+    print(f" * median [min; max]: {median:.2f}s [{mmin:.2f}s; {mmax:.2f}s]\n")
+
+
+def ampycloud_copy_prm_file() -> None:
+    """The ampycloud_copy_prm_file entry point, meant to be launched from the command line."""
+
+    # Use argparse to make ampycloud user friendly
+    parser = argparse.ArgumentParser(
+        description=f"ampycloud {VERSION}"
+        + " - Python package to characterize cloud layers"
+        + " using ceilometer measurements.\n"
+        + "This entry point lets you get a local copy the ampycloud parameter files.",
+        epilog="For details: https://MeteoSwiss.github.io/ampycloud\n ",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+
+    parser.add_argument(
+        "-which",
+        action="store",
+        default="default",
+        type=str,
+        metavar="name",
+        help='Name of the parameter file to copy. Defaults to "default".',
+    )
+
+    # Done getting ready. Now start doing stuff.
+    # What did the user type in ?
+    args = parser.parse_args()
+
+    # Get the local copy
+    copy_prm_file(which=args.which)
+
+    print("\nSuccess.")