diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..8f860c4 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @btschwertfeger diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1a55e04..7e4e2b9 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.5.0 + rev: v4.6.0 hooks: - id: check-yaml - id: end-of-file-fixer @@ -22,6 +22,5 @@ repos: hooks: - id: python-use-type-annotations - id: rst-backticks - # - id: rst-inline-touching-normal - id: rst-directive-colons - id: text-unicode-replacement-char diff --git a/CHANGELOG.md b/CHANGELOG.md index 0be1a1a..b22170f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,37 @@ ## [Unreleased](https://github.com/btschwertfeger/BiasAdjustCXX/tree/HEAD) -[Full Changelog](https://github.com/btschwertfeger/BiasAdjustCXX/compare/v1.9.0...HEAD) +[Full Changelog](https://github.com/btschwertfeger/BiasAdjustCXX/compare/v1.9.3...HEAD) + +**Fixed bugs:** + +- The -v option is used twice, for `--variable` and `--version` [\#39](https://github.com/btschwertfeger/BiasAdjustCXX/issues/39) + +## [v1.9.3](https://github.com/btschwertfeger/BiasAdjustCXX/tree/v1.9.3) (2024-09-09) + +[Full Changelog](https://github.com/btschwertfeger/BiasAdjustCXX/compare/v1.9.2...v1.9.3) + +**Fixed bugs:** + +- The -v option is used twice, for `--variable` and `--version` [\#39](https://github.com/btschwertfeger/BiasAdjustCXX/issues/39) +- Resolve "The -v option is used twice, for `--variable` and `--version`" [\#40](https://github.com/btschwertfeger/BiasAdjustCXX/pull/40) ([btschwertfeger](https://github.com/btschwertfeger)) + +## [v1.9.2](https://github.com/btschwertfeger/BiasAdjustCXX/tree/v1.9.2) (2024-02-02) + +[Full Changelog](https://github.com/btschwertfeger/BiasAdjustCXX/compare/v1.9.1...v1.9.2) + +**Merged pull requests:** + +- Update documentation, readme and update workflows [\#37](https://github.com/btschwertfeger/BiasAdjustCXX/pull/37) ([btschwertfeger](https://github.com/btschwertfeger)) + +## [v1.9.1](https://github.com/btschwertfeger/BiasAdjustCXX/tree/v1.9.1) (2023-08-09) + +[Full Changelog](https://github.com/btschwertfeger/BiasAdjustCXX/compare/v1.9.0...v1.9.1) + +**Fixed bugs:** + +- The tool runs into segmentation faults when the input data contains NAN values [\#32](https://github.com/btschwertfeger/BiasAdjustCXX/issues/32) +- Fix segmentation fault for time series including NaN values [\#31](https://github.com/btschwertfeger/BiasAdjustCXX/pull/31) ([btschwertfeger](https://github.com/btschwertfeger)) **Merged pull requests:** diff --git a/README.rst b/README.rst index f316199..884b6ce 100644 --- a/README.rst +++ b/README.rst @@ -25,6 +25,8 @@ BiasAdjustCXX command-line tool for the application of fast and efficient bias c .. |CMake badge| image:: https://img.shields.io/badge/required-CMake3.10%2B-brightgreen +.. |GoogleTest badge| image:: https://img.shields.io/badge/GoogleTest-1.11.0-blue + .. |DOI badge| image:: https://zenodo.org/badge/495881923.svg :target: https://zenodo.org/badge/latestdoi/495881923 @@ -80,16 +82,21 @@ BiasAdjustCXX command-line tool for the application of fast and efficient bias c |GitHub badge| |License badge| |C++ badge| |CICD badge| -|Docker pulls badge| |GCC badge| |CMake badge| +|Docker pulls badge| |GCC badge| |CMake badge| |GoogleTest badge| |Release date badge| |Release tag badge| |DOI badge| |Publication badge| **The documentation can be found here: https://biasadjustcxx.readthedocs.io/en/latest.** -Related project: `python-cmethods`_ - This software is tested using Google's testing framework *googletest* (https://github.com/google/googletest). +The related project `python-cmethods`_ is a Python package that is implemented +in Python and is way more flexible in terms of parameters, input data, shapes, +and customization. For those who know Python at least a bit, this might be the +better option, as it not only provides a command-line interface but also enables +accessing its API in order to apply custom bias corrections. + + 1. About -------- diff --git a/doc/src/introduction.rst b/doc/src/introduction.rst index 6679724..4262f10 100644 --- a/doc/src/introduction.rst +++ b/doc/src/introduction.rst @@ -95,6 +95,12 @@ General Notes - same length as the time series to be adjusted. - Examples can be found in the `BiasAdjustCXX`_ repository and of course within this documentation. +- The related project `python-cmethods`_ is a Python package that is + implemented in Python and is way more flexible in terms of parameters, input + data, shapes, and customization. For those who know Python at least a bit, + this might be the better option, as it not only provides a command-line + interface but also enables accessing its API in order to apply custom bias + corrections. - Speed/Performance tests and comparison to other tools can be found here: `tool comparison`_ - References can be found in the :ref:`References` section.