Prepare release (#35)

Author: btschwertfeger

CHANGELOG.md

@@ -4,10 +4,25 @@
 
 [Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v1.0.0...HEAD)
 
+**Breaking changes:**
+
+- Split Quantile Mapping into Quantile Mapping and Detrended Quantile Mapping [\#34](https://github.com/btschwertfeger/python-cmethods/pull/34) ([btschwertfeger](https://github.com/btschwertfeger))
+
 **Fixed bugs:**
 
+- Multiplicative Quantile Delta Mapping is not applying scaling where the delta is infinite [\#32](https://github.com/btschwertfeger/python-cmethods/issues/32)
+- Fixed bug where division lead to nan or inf values [\#33](https://github.com/btschwertfeger/python-cmethods/pull/33) ([btschwertfeger](https://github.com/btschwertfeger))
 - Fixed PyPI repository URL [\#16](https://github.com/btschwertfeger/python-cmethods/pull/16) ([btschwertfeger](https://github.com/btschwertfeger))
 
+**Closed issues:**
+
+- Create a changelog [\#19](https://github.com/btschwertfeger/python-cmethods/issues/19)
+
+**Merged pull requests:**
+
+- Create a Changelog [\#21](https://github.com/btschwertfeger/python-cmethods/pull/21) ([btschwertfeger](https://github.com/btschwertfeger))
+- Extended the description of quantile mapping with text and images [\#20](https://github.com/btschwertfeger/python-cmethods/pull/20) ([btschwertfeger](https://github.com/btschwertfeger))
+
 ## [v1.0.0](https://github.com/btschwertfeger/python-cmethods/tree/v1.0.0) (2023-04-10)
 
 [Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v0.6.3...v1.0.0)

Makefile

@@ -47,7 +47,7 @@ pre-commit:
 ##
 changelog:
 	docker run -it --rm \
-		-v "$(pwd)":/usr/local/src/python-cmethods \
+		-v "$(PWD)":/usr/local/src/your-app/ \
 		githubchangeloggenerator/github-changelog-generator \
 		-u btschwertfeger \
 		-p python-cmethods \

cmethods/__init__.py

@@ -881,7 +881,8 @@ def detrended_quantile_mapping(
         Precipitation by Quantile Mapping: How Well Do Methods Preserve Changes in Quantiles
         and Extremes?"* (https://doi.org/10.1175/JCLI-D-14-00754.1).
 
-        In the following the equations of Alex J. Cannon (2015) are shown and explained (without detrending):
+        In the following the equations of Alex J. Cannon (2015) are shown (without detrending; see QM
+        for explainations):
 
         **Additive**:
 
@@ -1104,7 +1105,7 @@ def quantile_delta_mapping(
                 .. math::
 
                     \Delta(i) & = \frac{ F^{-1}_{sim,p}\left[\varepsilon(i)\right] }{ F^{-1}_{sim,h}\left[\varepsilon(i)\right] } \\[1pt]
-                              & = \frac{ X_{sim,p}(i) }{ F^{-1}_{sim,h}\left\{F^_{sim,p}\left[X_{sim,p}(i)\right]\right\} }
+                              & = \frac{ X_{sim,p}(i) }{ F^{-1}_{sim,h}\left\{F_{sim,p}\left[X_{sim,p}(i)\right]\right\} }
 
 
             **(2.4)** The relative change between the modeled data of the control and scenario period is than
@@ -1201,7 +1202,7 @@ def ensure_devidable(
     ) -> np.array:
         """
         Ensures that the arrays can be devided. The numerator will be multiplied by
-        the maximum scaling factor of the CMethods class.
+        the maximum scaling factor of the CMethods class if division by zero.
 
         :param numerator: Numerator to use
         :type numerator: np.array

docs/src/license.rst

@@ -4,4 +4,4 @@
 License
 =======
 
-.. include:: ../../../LICENSE
+.. include:: ../../LICENSE