From a2fb24db14af56cf4323c093ac71d769f883f6a3 Mon Sep 17 00:00:00 2001 From: Benjamin Thomas Schwertfeger Date: Sun, 9 Feb 2025 08:30:33 +0100 Subject: [PATCH] Update copyright header --- .github/dependabot.yaml | 20 ++--- .github/release.yaml | 6 +- .github/workflows/_build.yaml | 6 +- .github/workflows/_build_doc.yaml | 6 +- .github/workflows/_codecov.yaml | 6 +- .github/workflows/_pre_commit.yaml | 6 +- .github/workflows/_pypi_publish.yaml | 6 +- .github/workflows/_pypi_test_publish.yaml | 6 +- .github/workflows/_test.yaml | 6 +- .github/workflows/cicd.yaml | 6 +- .../workflows/dependabot_auto_approve.yaml | 6 +- .pre-commit-config.yaml | 9 +- .readthedocs.yaml | 1 + CHANGELOG.md | 79 +++++++++++++++-- MANIFEST.in | 4 +- Makefile | 6 +- README.md | 2 +- cmethods/__init__.py | 7 +- cmethods/core.py | 7 +- cmethods/distribution.py | 7 +- cmethods/scaling.py | 7 +- cmethods/static.py | 7 +- cmethods/types.py | 7 +- cmethods/utils.py | 7 +- doc/Makefile | 2 + doc/cli.rst | 6 +- doc/cmethods.rst | 6 +- doc/conf.py | 7 +- doc/getting_started.rst | 6 +- doc/index.rst | 6 +- doc/introduction.rst | 6 +- doc/issues.rst | 6 +- doc/license.rst | 6 +- doc/links.rst | 87 ++++++++----------- doc/methods.rst | 6 +- pyproject.toml | 7 ++ setup.py | 8 +- tests/__init__.py | 11 +-- tests/conftest.py | 7 +- tests/helper.py | 9 +- tests/test_cli.py | 7 +- tests/test_methods.py | 7 +- tests/test_methods_different_input_shape.py | 7 +- tests/test_misc.py | 7 +- tests/test_utils.py | 7 +- tests/test_zarr_dask_compatibility.py | 7 +- 46 files changed, 286 insertions(+), 172 deletions(-) diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml index 63713e6..d8fd775 100644 --- a/.github/dependabot.yaml +++ b/.github/dependabot.yaml @@ -1,16 +1,10 @@ +# -*- mode: yaml; coding: utf-8 -*- version: 2 updates: - - package-ecosystem: "github-actions" - directory: "/" + - package-ecosystem: github-actions + directory: / schedule: - interval: "weekly" - reviewers: - - "btschwertfeger" - - package-ecosystem: "pip" - directory: "/" - schedule: - interval: "weekly" - reviewers: - - "btschwertfeger" - ignore: - - dependency-name: "ruff" + interval: monthly + groups: + all: + dependency-type: production diff --git a/.github/release.yaml b/.github/release.yaml index 5315a53..d5144ad 100644 --- a/.github/release.yaml +++ b/.github/release.yaml @@ -1,6 +1,8 @@ -# -*- coding: utf-8 -*- +# -*- mode: yaml; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # # Config file to auto-generate release notes based on # https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes diff --git a/.github/workflows/_build.yaml b/.github/workflows/_build.yaml index 0d3305d..6d98a66 100644 --- a/.github/workflows/_build.yaml +++ b/.github/workflows/_build.yaml @@ -1,6 +1,8 @@ -# -*- coding: utf-8 -*- +# -*- mode: yaml; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # # Template workflow to build the project for a specific os # and Python version. diff --git a/.github/workflows/_build_doc.yaml b/.github/workflows/_build_doc.yaml index eb92145..e106017 100644 --- a/.github/workflows/_build_doc.yaml +++ b/.github/workflows/_build_doc.yaml @@ -1,6 +1,8 @@ -# -*- coding: utf-8 -*- +# -*- mode: yaml; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # # Template workflow to build documentation. # diff --git a/.github/workflows/_codecov.yaml b/.github/workflows/_codecov.yaml index 7f32ca6..0d39fcc 100644 --- a/.github/workflows/_codecov.yaml +++ b/.github/workflows/_codecov.yaml @@ -1,6 +1,8 @@ -# -*- coding: utf-8 -*- +# -*- mode: yaml; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # # Template workflow to build the project for a specific os # and Python version, run the tests and upload the results to codecov. diff --git a/.github/workflows/_pre_commit.yaml b/.github/workflows/_pre_commit.yaml index 8b8408c..20c56f3 100644 --- a/.github/workflows/_pre_commit.yaml +++ b/.github/workflows/_pre_commit.yaml @@ -1,6 +1,8 @@ -# -*- coding: utf-8 -*- +# -*- mode: yaml; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # # Template workflow to run pre-commit. # diff --git a/.github/workflows/_pypi_publish.yaml b/.github/workflows/_pypi_publish.yaml index a304e3b..232fe7f 100644 --- a/.github/workflows/_pypi_publish.yaml +++ b/.github/workflows/_pypi_publish.yaml @@ -1,6 +1,8 @@ -# -*- coding: utf-8 -*- +# -*- mode: yaml; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # # Template workflow to build the project and publish # the package to PyPI. diff --git a/.github/workflows/_pypi_test_publish.yaml b/.github/workflows/_pypi_test_publish.yaml index 638abd2..a2aedf2 100644 --- a/.github/workflows/_pypi_test_publish.yaml +++ b/.github/workflows/_pypi_test_publish.yaml @@ -1,6 +1,8 @@ -# -*- coding: utf-8 -*- +# -*- mode: yaml; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # # Template workflow to build the project and publish # the package to test PyPI. diff --git a/.github/workflows/_test.yaml b/.github/workflows/_test.yaml index ebb1e86..09b91cd 100644 --- a/.github/workflows/_test.yaml +++ b/.github/workflows/_test.yaml @@ -1,6 +1,8 @@ -# -*- coding: utf-8 -*- +# -*- mode: yaml; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # # Template workflow to run the unit tests of the package # diff --git a/.github/workflows/cicd.yaml b/.github/workflows/cicd.yaml index 8485538..08b4fb7 100644 --- a/.github/workflows/cicd.yaml +++ b/.github/workflows/cicd.yaml @@ -1,6 +1,8 @@ -# -*- coding: utf-8 -*- +# -*- mode: yaml; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # # Workflow to apply pre-commit, build, test and upload the package # to the test index of PyPI. diff --git a/.github/workflows/dependabot_auto_approve.yaml b/.github/workflows/dependabot_auto_approve.yaml index f0f77e4..5f542ca 100644 --- a/.github/workflows/dependabot_auto_approve.yaml +++ b/.github/workflows/dependabot_auto_approve.yaml @@ -1,6 +1,8 @@ -# -*- coding: utf-8 -*- +# -*- mode: yaml; coding: utf-8 -*- +# # Copyright (C) 2024 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # # Workflow that approves and merges all pull requests from the dependabot[bot] # author. diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 369746e..a1e6383 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,8 @@ -# -*- coding: utf-8 -*- -# Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# -*- mode: yaml; coding: utf-8 -*- +# +# Copyright (C) 2024 Benjamin Thomas Schwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # repos: @@ -43,7 +45,6 @@ repos: - id: check-executables-have-shebangs - id: trailing-whitespace - id: fix-byte-order-marker - - id: fix-encoding-pragma - id: requirements-txt-fixer - id: mixed-line-ending - id: name-tests-test diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9e653bd..e816ffa 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,3 +1,4 @@ +# -*- mode: yaml; coding: utf-8 -*- # .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details diff --git a/CHANGELOG.md b/CHANGELOG.md index 5674156..2c09226 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,68 @@ # Changelog +## [Unreleased](https://github.com/btschwertfeger/python-cmethods/tree/HEAD) + +[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v2.3.0...HEAD) + +**Fixed bugs:** + +- Update `cmethods.adjust`'s type annotations [\#155](https://github.com/btschwertfeger/python-cmethods/pull/155) ([btschwertfeger](https://github.com/btschwertfeger)) + +**Closed issues:** + +- Create Jupyter Notebooks for possible strategies [\#135](https://github.com/btschwertfeger/python-cmethods/issues/135) + +**Merged pull requests:** + +- Bump dependabot/fetch-metadata from 2.2.0 to 2.3.0 [\#159](https://github.com/btschwertfeger/python-cmethods/pull/159) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump actions/setup-python from 5.3.0 to 5.4.0 [\#156](https://github.com/btschwertfeger/python-cmethods/pull/156) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.28.0 to 3.28.1 [\#152](https://github.com/btschwertfeger/python-cmethods/pull/152) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Add `release.yaml` [\#151](https://github.com/btschwertfeger/python-cmethods/pull/151) ([btschwertfeger](https://github.com/btschwertfeger)) +- Bump codecov/codecov-action from 5.1.1 to 5.1.2 [\#150](https://github.com/btschwertfeger/python-cmethods/pull/150) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.27.9 to 3.28.0 [\#149](https://github.com/btschwertfeger/python-cmethods/pull/149) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.27.6 to 3.27.9 [\#148](https://github.com/btschwertfeger/python-cmethods/pull/148) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump codecov/codecov-action from 4.6.0 to 5.1.1 [\#147](https://github.com/btschwertfeger/python-cmethods/pull/147) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.27.4 to 3.27.6 [\#146](https://github.com/btschwertfeger/python-cmethods/pull/146) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Do not rely on trusted publishing for PyPI upload [\#145](https://github.com/btschwertfeger/python-cmethods/pull/145) ([btschwertfeger](https://github.com/btschwertfeger)) +- Bump github/codeql-action from 3.27.1 to 3.27.4 [\#141](https://github.com/btschwertfeger/python-cmethods/pull/141) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.27.0 to 3.27.1 [\#140](https://github.com/btschwertfeger/python-cmethods/pull/140) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump actions/checkout from 4.2.1 to 4.2.2 [\#138](https://github.com/btschwertfeger/python-cmethods/pull/138) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump actions/setup-python from 5.2.0 to 5.3.0 [\#137](https://github.com/btschwertfeger/python-cmethods/pull/137) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.26.13 to 3.27.0 [\#136](https://github.com/btschwertfeger/python-cmethods/pull/136) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Update and apply Pre-Commit hooks [\#134](https://github.com/btschwertfeger/python-cmethods/pull/134) ([btschwertfeger](https://github.com/btschwertfeger)) +- Bump actions/checkout from 4.1.7 to 4.2.1 [\#132](https://github.com/btschwertfeger/python-cmethods/pull/132) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.26.11 to 3.26.13 [\#131](https://github.com/btschwertfeger/python-cmethods/pull/131) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump codecov/codecov-action from 4.5.0 to 4.6.0 [\#130](https://github.com/btschwertfeger/python-cmethods/pull/130) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.26.8 to 3.26.11 [\#129](https://github.com/btschwertfeger/python-cmethods/pull/129) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Move CITATION file to top-level [\#126](https://github.com/btschwertfeger/python-cmethods/pull/126) ([btschwertfeger](https://github.com/btschwertfeger)) +- Add CITATION file [\#125](https://github.com/btschwertfeger/python-cmethods/pull/125) ([btschwertfeger](https://github.com/btschwertfeger)) +- Update project settings [\#124](https://github.com/btschwertfeger/python-cmethods/pull/124) ([btschwertfeger](https://github.com/btschwertfeger)) +- Bump github/codeql-action from 3.26.7 to 3.26.8 [\#123](https://github.com/btschwertfeger/python-cmethods/pull/123) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.26.6 to 3.26.7 [\#122](https://github.com/btschwertfeger/python-cmethods/pull/122) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump actions/setup-python from 5.1.1 to 5.2.0 [\#121](https://github.com/btschwertfeger/python-cmethods/pull/121) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.26.5 to 3.26.6 [\#120](https://github.com/btschwertfeger/python-cmethods/pull/120) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.26.2 to 3.26.5 [\#119](https://github.com/btschwertfeger/python-cmethods/pull/119) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.26.0 to 3.26.2 [\#118](https://github.com/btschwertfeger/python-cmethods/pull/118) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 3.25.15 to 3.26.0 [\#117](https://github.com/btschwertfeger/python-cmethods/pull/117) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump github/codeql-action from 2.2.4 to 3.25.15 [\#116](https://github.com/btschwertfeger/python-cmethods/pull/116) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump ossf/scorecard-action from 2.3.3 to 2.4.0 [\#115](https://github.com/btschwertfeger/python-cmethods/pull/115) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump actions/setup-python from 5.1.0 to 5.1.1 [\#114](https://github.com/btschwertfeger/python-cmethods/pull/114) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump dependabot/fetch-metadata from 2.1.0 to 2.2.0 [\#113](https://github.com/btschwertfeger/python-cmethods/pull/113) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump actions/checkout from 4.1.6 to 4.1.7 [\#110](https://github.com/btschwertfeger/python-cmethods/pull/110) ([dependabot[bot]](https://github.com/apps/dependabot)) + +## [v2.3.0](https://github.com/btschwertfeger/python-cmethods/tree/v2.3.0) (2024-06-19) + +[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v2.2.5...v2.3.0) + +**Implemented enhancements:** + +- Drop Python 3.8 Support [\#111](https://github.com/btschwertfeger/python-cmethods/issues/111) + +**Merged pull requests:** + +- Bump codecov/codecov-action from 4.4.1 to 4.5.0 [\#109](https://github.com/btschwertfeger/python-cmethods/pull/109) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Resolve "Drop Python 3.8 support" [\#112](https://github.com/btschwertfeger/python-cmethods/pull/112) ([btschwertfeger](https://github.com/btschwertfeger)) + ## [v2.2.5](https://github.com/btschwertfeger/python-cmethods/tree/v2.2.5) (2024-05-28) [Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v2.2.4...v2.2.5) @@ -73,7 +136,7 @@ **Implemented enhancements:** -- Add a command-line interface [\#82](https://github.com/btschwertfeger/python-cmethods/issues/82) +- Add a command-line interface [\#82](https://github.com/btschwertfeger/python-cmethods/issues/82) - Resolve "Add a command-line interface" [\#83](https://github.com/btschwertfeger/python-cmethods/pull/83) ([btschwertfeger](https://github.com/btschwertfeger)) **Merged pull requests:** @@ -112,7 +175,7 @@ **Closed issues:** -- The latest documentation still describes the legacy max_scaling_factor [\#60](https://github.com/btschwertfeger/python-cmethods/issues/60) +- The latest documentation still describes the legacy max\_scaling\_factor [\#60](https://github.com/btschwertfeger/python-cmethods/issues/60) **Merged pull requests:** @@ -160,7 +223,7 @@ **Merged pull requests:** -- Clarified difference between stochastic and non-stochastic climate variables in doc and readme [\#36](https://github.com/btschwertfeger/python-cmethods/pull/36) ([btschwertfeger](https://github.com/btschwertfeger)) +- Clarified difference between stochastic and non-stochastic climate variables in doc and readme [\#36](https://github.com/btschwertfeger/python-cmethods/pull/36) ([btschwertfeger](https://github.com/btschwertfeger)) - Fix typos [\#38](https://github.com/btschwertfeger/python-cmethods/pull/38) ([btschwertfeger](https://github.com/btschwertfeger)) ## [v1.0.1](https://github.com/btschwertfeger/python-cmethods/tree/v1.0.1) (2023-04-17) @@ -174,7 +237,7 @@ **Fixed bugs:** -- Multiplicative Quantile Delta Mapping is not applying scaling where the delta is infinite [\#32](https://github.com/btschwertfeger/python-cmethods/issues/32) +- Multiplicative Quantile Delta Mapping is not applying scaling where the delta is infinite [\#32](https://github.com/btschwertfeger/python-cmethods/issues/32) - Fixed PyPI repository URL [\#16](https://github.com/btschwertfeger/python-cmethods/pull/16) ([btschwertfeger](https://github.com/btschwertfeger)) - Fixed bug where division lead to nan or inf values [\#33](https://github.com/btschwertfeger/python-cmethods/pull/33) ([btschwertfeger](https://github.com/btschwertfeger)) @@ -194,7 +257,7 @@ **Breaking changes:** -- Remove the unnecessary `CMethods.py` module to access the CMethods class more easily [\#10](https://github.com/btschwertfeger/python-cmethods/issues/10) +- Remove the unnecessary `CMethods.py` module to access the CMethods class more easily [\#10](https://github.com/btschwertfeger/python-cmethods/issues/10) **Implemented enhancements:** @@ -219,7 +282,7 @@ **Breaking changes:** -- adjust_3d forces group to be "time.month" if group is set to the default \(None\) [\#5](https://github.com/btschwertfeger/python-cmethods/issues/5) +- adjust\_3d forces group to be "time.month" if group is set to the default \(None\) [\#5](https://github.com/btschwertfeger/python-cmethods/issues/5) **Implemented enhancements:** @@ -277,4 +340,6 @@ [Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/41c1837e5d23c300656c8ee2ce0079d6a8baac2f...v0.5) -\* _This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)_ + + +\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* diff --git a/MANIFEST.in b/MANIFEST.in index e9f05fc..d434235 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,8 @@ # -*- coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # include README.md LICENSE diff --git a/Makefile b/Makefile index aec323f..c6e04e8 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,9 @@ +# -*- mode: make; coding: utf-8 -*- #!make -# -*- coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # VENV := venv diff --git a/README.md b/README.md index 979bbe0..bdc5824 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@
[![GitHub](https://badgen.net/badge/icon/github?icon=github&label)](https://github.com/btschwertfeger/python-cmethods) -[![Generic badge](https://img.shields.io/badge/python-3.9_|_3.10_|_3.11|_3.12-blue.svg)](https://shields.io/) +[![Generic badge](https://img.shields.io/badge/python-3.9_|_3.10_|_3.11|_3.12|_3.13-blue.svg)](https://shields.io/) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-orange.svg)](https://www.gnu.org/licenses/gpl-3.0) [![PyPI Downloads](https://pepy.tech/badge/python-cmethods)](https://pepy.tech/project/python-cmethods) diff --git a/cmethods/__init__.py b/cmethods/__init__.py index b91ca6f..87eacb1 100644 --- a/cmethods/__init__.py +++ b/cmethods/__init__.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # # pylint: disable=consider-using-f-string,logging-not-lazy diff --git a/cmethods/core.py b/cmethods/core.py index 84afc01..3c5996f 100644 --- a/cmethods/core.py +++ b/cmethods/core.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2024 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """ diff --git a/cmethods/distribution.py b/cmethods/distribution.py index 2f2772c..14737c3 100644 --- a/cmethods/distribution.py +++ b/cmethods/distribution.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2024 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """ diff --git a/cmethods/scaling.py b/cmethods/scaling.py index e01c7b3..766231b 100644 --- a/cmethods/scaling.py +++ b/cmethods/scaling.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2024 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """ diff --git a/cmethods/static.py b/cmethods/static.py index 697666c..cb311ab 100644 --- a/cmethods/static.py +++ b/cmethods/static.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """Module providing static information for the python-cmethods package""" diff --git a/cmethods/types.py b/cmethods/types.py index 925bf1d..c670699 100644 --- a/cmethods/types.py +++ b/cmethods/types.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """Module providing custom types""" diff --git a/cmethods/utils.py b/cmethods/utils.py index 19d687b..81f27f9 100644 --- a/cmethods/utils.py +++ b/cmethods/utils.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """Module providing utility functions""" diff --git a/doc/Makefile b/doc/Makefile index 1c0cc00..de3407a 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,3 +1,5 @@ +# -*- mode: make; coding: utf-8 -*- +#!make # Minimal makefile for Sphinx documentation # diff --git a/doc/cli.rst b/doc/cli.rst index 399ffa9..e05557e 100644 --- a/doc/cli.rst +++ b/doc/cli.rst @@ -1,6 +1,8 @@ -.. -*- coding: utf-8 -*- +.. -*- mode: rst; coding: utf-8 -*- +.. .. Copyright (C) 2023 Benjamin Thomas Schwertfeger -.. GitHub: https://github.com/btschwertfeger +.. All rights reserved. +.. https://github.com/btschwertfeger .. Command-Line Interface diff --git a/doc/cmethods.rst b/doc/cmethods.rst index 00bfe32..65375da 100644 --- a/doc/cmethods.rst +++ b/doc/cmethods.rst @@ -1,6 +1,8 @@ -.. -*- coding: utf-8 -*- +.. -*- mode: rst; coding: utf-8 -*- +.. .. Copyright (C) 2023 Benjamin Thomas Schwertfeger -.. GitHub: https://github.com/btschwertfeger +.. All rights reserved. +.. https://github.com/btschwertfeger .. Classes and Functions diff --git a/doc/conf.py b/doc/conf.py index 0ca2c85..5e8ccfa 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,4 +1,9 @@ -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# +# Copyright (C) 2023 Benjamin Thomas Schwertfeger +# All rights reserved. +# https://github.com/btschwertfeger +# # Configuration file for the Sphinx documentation builder. # # For the full list of built-in configuration values, see the documentation: diff --git a/doc/getting_started.rst b/doc/getting_started.rst index dad6257..2548f8d 100644 --- a/doc/getting_started.rst +++ b/doc/getting_started.rst @@ -1,6 +1,8 @@ -.. -*- coding: utf-8 -*- +.. -*- mode: rst; coding: utf-8 -*- +.. .. Copyright (C) 2023 Benjamin Thomas Schwertfeger -.. GitHub: https://github.com/btschwertfeger +.. All rights reserved. +.. https://github.com/btschwertfeger .. Getting Started diff --git a/doc/index.rst b/doc/index.rst index e6b6763..f2b4759 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,6 +1,8 @@ -.. -*- coding: utf-8 -*- +.. -*- mode: rst; coding: utf-8 -*- +.. .. Copyright (C) 2023 Benjamin Thomas Schwertfeger -.. GitHub: https://github.com/btschwertfeger +.. All rights reserved. +.. https://github.com/btschwertfeger .. Welcome to python-cmethods's documentation! diff --git a/doc/introduction.rst b/doc/introduction.rst index 99344e4..9dec6ae 100644 --- a/doc/introduction.rst +++ b/doc/introduction.rst @@ -1,6 +1,8 @@ -.. -*- coding: utf-8 -*- +.. -*- mode: rst; coding: utf-8 -*- +.. .. Copyright (C) 2023 Benjamin Thomas Schwertfeger -.. GitHub: https://github.com/btschwertfeger +.. All rights reserved. +.. https://github.com/btschwertfeger .. python-cmethods diff --git a/doc/issues.rst b/doc/issues.rst index 46dfd72..6c150f4 100644 --- a/doc/issues.rst +++ b/doc/issues.rst @@ -1,6 +1,8 @@ -.. -*- coding: utf-8 -*- +.. -*- mode: rst; coding: utf-8 -*- +.. .. Copyright (C) 2023 Benjamin Thomas Schwertfeger -.. GitHub: https://github.com/btschwertfeger +.. All rights reserved. +.. https://github.com/btschwertfeger .. Known Issues diff --git a/doc/license.rst b/doc/license.rst index a839fd6..9245eea 100644 --- a/doc/license.rst +++ b/doc/license.rst @@ -1,6 +1,8 @@ -.. -*- coding: utf-8 -*- +.. -*- mode: rst; coding: utf-8 -*- +.. .. Copyright (C) 2023 Benjamin Thomas Schwertfeger -.. GitHub: https://github.com/btschwertfeger +.. All rights reserved. +.. https://github.com/btschwertfeger .. .. _section-license: diff --git a/doc/links.rst b/doc/links.rst index 0ae9555..c2de0ab 100644 --- a/doc/links.rst +++ b/doc/links.rst @@ -1,70 +1,51 @@ -.. -*- coding: utf-8 -*- +.. -*- mode: rst; coding: utf-8 -*- +.. .. Copyright (C) 2023 Benjamin Thomas Schwertfeger -.. GitHub: https://github.com/btschwertfeger +.. All rights reserved. +.. https://github.com/btschwertfeger .. .. LINKS .. _python-cmethods: https://github.com/btschwertfeger/python-cmethods - .. _python_cmethods-conda: https://anaconda.org/conda-forge/python_cmethods - .. _python-cmethods/issues: https://github.com/btschwertfeger/python-cmethods/issues - .. _python-cmethods/discussions: https://github.com/btschwertfeger/python-cmethods/discussions - .. _BiasAdjustCXX: https://github.com/btschwertfeger/BiasAdjustCXX - .. _tool comparison: https://github.com/btschwertfeger/BiasAdjustCXX-Performance-Test - .. _xclim: https://zenodo.org/record/7535677 - .. _xarray: https://xarray.dev/ - .. _dask: https://docs.dask.org/en/stable/ - .. BADGES -.. |GitHub badge| image:: https://badgen.net/badge/icon/github?icon=github&label - :target: https://github.com/btschwertfeger/python-cmethods - -.. |License badge| image:: https://img.shields.io/badge/License-GPLv3-orange.svg - :target: https://www.gnu.org/licenses/gpl-3.0 - -.. |PyVersions badge| image:: https://img.shields.io/badge/python-3.9_|_3.10_|_3.11|_3.12-blue.svg - :target: https://github.com/btschwertfeger/python-cmethods - -.. |Downloads badge| image:: https://static.pepy.tech/personalized-badge/python-cmethods?period=total&units=abbreviation&left_color=grey&right_color=orange&left_text=downloads - :target: https://pepy.tech/project/python-cmethods - -.. |CI/CD badge| image:: https://github.com/btschwertfeger/python-cmethods/actions/workflows/cicd.yaml/badge.svg?branch=master - :target: https://github.com/btschwertfeger/python-cmethods/actions/workflows/cicd.yaml - -.. |codecov badge| image:: https://codecov.io/gh/btschwertfeger/python-cmethods/branch/master/badge.svg - :target: https://app.codecov.io/gh/btschwertfeger/python-cmethods - -.. |Release date badge| image:: https://shields.io/github/release-date/btschwertfeger/python-cmethods - :target: https://github.com/btschwertfeger/python-cmethods - -.. |Release version badge| image:: https://shields.io/github/v/release/btschwertfeger/python-cmethods?display_name=tag - :target: https://github.com/btschwertfeger/python-cmethods - -.. |DOI badge| image:: https://zenodo.org/badge/496160109.svg - :target: https://zenodo.org/badge/latestdoi/496160109 - -.. |Docs latest| image:: https://readthedocs.org/projects/python-cmethods/badge/?version=latest - :target: https://python-cmethods.readthedocs.io/en/latest - :alt: Documentation Status latest - -.. |Docs stable| image:: https://readthedocs.org/projects/python-cmethods/badge/?version=stable - :target: https://python-cmethods.readthedocs.io/en/stable - :alt: Documentation Status stable - -.. |OSSF Scorecard| image:: https://img.shields.io/ossf-scorecard/github.com/btschwertfeger/python-cmethods?label=openssf%20scorecard&style=flat - :target: https://securityscorecards.dev/viewer/?uri=github.com/btschwertfeger/python-cmethods - :alt: OSSF Scorecard - -.. |OSSF Best Practices| image:: https://www.bestpractices.dev/projects/8666/badge - :target: https://www.bestpractices.dev/projects/8666 - :alt: OSSF Best Practices +.. |GitHub badge| image:: https://badgen.net/badge/icon/github?icon=github&label + :target: https://github.com/btschwertfeger/python-cmethods +.. |License badge| image:: https://img.shields.io/badge/License-GPLv3-orange.svg + :target: https://www.gnu.org/licenses/gpl-3.0 +.. |PyVersions badge| image:: https://img.shields.io/badge/python-3.9_|_3.10_|_3.11|_3.12|_3.13-blue.svg + :target: https://github.com/btschwertfeger/python-cmethods +.. |Downloads badge| image:: https://static.pepy.tech/personalized-badge/python-cmethods?period=total&units=abbreviation&left_color=grey&right_color=orange&left_text=downloads + :target: https://pepy.tech/project/python-cmethods +.. |CI/CD badge| image:: https://github.com/btschwertfeger/python-cmethods/actions/workflows/cicd.yaml/badge.svg?branch=master + :target: https://github.com/btschwertfeger/python-cmethods/actions/workflows/cicd.yaml +.. |codecov badge| image:: https://codecov.io/gh/btschwertfeger/python-cmethods/branch/master/badge.svg + :target: https://app.codecov.io/gh/btschwertfeger/python-cmethods +.. |Release date badge| image:: https://shields.io/github/release-date/btschwertfeger/python-cmethods + :target: https://github.com/btschwertfeger/python-cmethods +.. |Release version badge| image:: https://shields.io/github/v/release/btschwertfeger/python-cmethods?display_name=tag + :target: https://github.com/btschwertfeger/python-cmethods +.. |DOI badge| image:: https://zenodo.org/badge/496160109.svg + :target: https://zenodo.org/badge/latestdoi/496160109 +.. |Docs latest| image:: https://readthedocs.org/projects/python-cmethods/badge/?version=latest + :target: https://python-cmethods.readthedocs.io/en/latest + :alt: Documentation Status latest +.. |Docs stable| image:: https://readthedocs.org/projects/python-cmethods/badge/?version=stable + :target: https://python-cmethods.readthedocs.io/en/stable + :alt: Documentation Status stable +.. |OSSF Scorecard| image:: https://img.shields.io/ossf-scorecard/github.com/btschwertfeger/python-cmethods?label=openssf%20scorecard&style=flat + :target: https://securityscorecards.dev/viewer/?uri=github.com/btschwertfeger/python-cmethods + :alt: OSSF Scorecard +.. |OSSF Best Practices| image:: https://www.bestpractices.dev/projects/8666/badge + :target: https://www.bestpractices.dev/projects/8666 + :alt: OSSF Best Practices diff --git a/doc/methods.rst b/doc/methods.rst index 2501f90..6316532 100644 --- a/doc/methods.rst +++ b/doc/methods.rst @@ -1,6 +1,8 @@ -.. -*- coding: utf-8 -*- +.. -*- mode: rst; coding: utf-8 -*- +.. .. Copyright (C) 2023 Benjamin Thomas Schwertfeger -.. GitHub: https://github.com/btschwertfeger +.. All rights reserved. +.. https://github.com/btschwertfeger .. Bias Correction Methods diff --git a/pyproject.toml b/pyproject.toml index 6ec1869..89e4ce4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,3 +1,10 @@ +# -*- coding: utf-8 -*- +# +# Copyright (C) 2023 Benjamin Thomas Schwertfeger +# All rights reserved. +# https://github.com/btschwertfeger +# + [build-system] requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2", "wheel"] build-backend = "setuptools.build_meta" diff --git a/setup.py b/setup.py index 5a37f97..47d9a7a 100644 --- a/setup.py +++ b/setup.py @@ -1,7 +1,9 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger +# # # This file is only used by sphinx for liking the package to the documentation. diff --git a/tests/__init__.py b/tests/__init__.py index cde4d87..50fce1c 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- -# Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# -*- mode: python; coding: utf-8 -*- +# +# Copyright (C) 2024 Benjamin Thomas Schwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # -# This file is required for being able to import from ".". +# This file is required for the codecov CI/CD job. diff --git a/tests/conftest.py b/tests/conftest.py index 639dada..9ac47ad 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """Module providing fixtures for testing.""" diff --git a/tests/helper.py b/tests/helper.py index e37e283..0aacd87 100644 --- a/tests/helper.py +++ b/tests/helper.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- -# Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# -*- mode: python; coding: utf-8 -*- +# +# Copyright (C) 2024 Benjamin Thomas Schwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """Module providing utility functions for testing.""" diff --git a/tests/test_cli.py b/tests/test_cli.py index 73eea47..d5e4507 100644 --- a/tests/test_cli.py +++ b/tests/test_cli.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2024 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """Module implementing the tests regarding the CLI""" diff --git a/tests/test_methods.py b/tests/test_methods.py index 315e823..53dd986 100644 --- a/tests/test_methods.py +++ b/tests/test_methods.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """ diff --git a/tests/test_methods_different_input_shape.py b/tests/test_methods_different_input_shape.py index cf7aec7..9eef638 100644 --- a/tests/test_methods_different_input_shape.py +++ b/tests/test_methods_different_input_shape.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2024 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """ diff --git a/tests/test_misc.py b/tests/test_misc.py index 3f793c4..da8ba92 100644 --- a/tests/test_misc.py +++ b/tests/test_misc.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """Module implementing even more tests""" diff --git a/tests/test_utils.py b/tests/test_utils.py index c915296..023510b 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2023 Benjamin Thomas Schwertfeger -# GitGub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # """ diff --git a/tests/test_zarr_dask_compatibility.py b/tests/test_zarr_dask_compatibility.py index 5f691df..ef91a9a 100644 --- a/tests/test_zarr_dask_compatibility.py +++ b/tests/test_zarr_dask_compatibility.py @@ -1,7 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# -*- mode: python; coding: utf-8 -*- +# # Copyright (C) 2024 Benjamin Thomas Schwertfeger -# GitHub: https://github.com/btschwertfeger +# All rights reserved. +# https://github.com/btschwertfeger # from typing import Any