time_series module

.github/workflows/release.yml

@@ -40,7 +40,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Create GitHub Release with Commitizen
-        uses: Serapieum-of-alex/github-actions/actions/release/github@main
+        uses: Serapieum-of-alex/github-actions/actions/release/github@github-release/v1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           release-branch: ${{ github.event.inputs.release-branch }}

README.md

@@ -17,15 +17,14 @@
 Current release info
 ====================
 
+Repository: [GitHub](https://github.com/Serapieum-of-alex/statista)
+conda-forge feedstock: [![Repo: statista-feedstock](https://img.shields.io/badge/repo‑statista--feedstock-blue)](https://github.com/conda-forge/statista-feedstock)
+Documentation: [GitHub Pages](https://serapieum-of-alex.github.io/statista)
+
 | Name | Downloads                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Version | Platforms |
 | --- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- | --- |
 | [![Conda Recipe](https://img.shields.io/badge/recipe-statista-green.svg)](https://anaconda.org/conda-forge/statista) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/statista.svg)](https://anaconda.org/conda-forge/statista) [![Downloads](https://pepy.tech/badge/statista)](https://pepy.tech/project/statista) [![Downloads](https://pepy.tech/badge/statista/month)](https://pepy.tech/project/statista)  [![Downloads](https://pepy.tech/badge/statista/week)](https://pepy.tech/project/statista)  ![PyPI - Downloads](https://img.shields.io/pypi/dd/statista?color=blue&style=flat-square) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/statista.svg)](https://anaconda.org/conda-forge/statista) [![PyPI version](https://badge.fury.io/py/statista.svg)](https://badge.fury.io/py/statista) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/statista/badges/version.svg)](https://anaconda.org/conda-forge/statista) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/statista.svg)](https://anaconda.org/conda-forge/statista) [![Join the chat at https://gitter.im/Hapi-Nile/Hapi](https://badges.gitter.im/Hapi-Nile/Hapi.svg)](https://gitter.im/Hapi-Nile/Hapi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
 
-
-conda-forge feedstock
-=====================
-[Conda-forge feedstock](https://github.com/conda-forge/statista-feedstock)
-
 ## Installation
 
 ### Conda (Recommended)
@@ -101,7 +100,7 @@ fig, ax = dist.plot()
 ### Extreme Value Analysis
 
 ```python
-from statista.distributions import GEV, PlottingPosition
+from statista.distributions import PlottingPosition
 
 # Create a GEV distribution
 gev_dist = Distributions("GEV", data)

mkdocs.yml

@@ -106,6 +106,7 @@ nav:
   - Installation: installation.md
   - Reference:
     - Distributions: reference/distributions-class.md
+    - Time Series: reference/time-series-class.md
     - Extreme Value Analysis: reference/eva-class.md
     - Descriptors: reference/descriptors-module.md
     - Plot: reference/plot-class.md

pyproject.toml

@@ -90,6 +90,7 @@ tag_format = "$version"
 changelog_file = "docs/change-log.md"
 changelog_incremental = true
 changelog_merge_prerelease = true
+update_changelog_on_bump = true
 
 [tool.commitizen.customize]
 message_template = "{{change_type}}:{% if show_message %} {{message}}{% endif %}"

src/statista/descriptors.py

@@ -34,7 +34,7 @@ def rmse(obs: Union[list, np.ndarray], sim: Union[list, np.ndarray]) -> float:
             >>> simulated = [1.1, 2.1, 2.9, 4.2, 5.2]
             >>> rmse_value = rmse(observed, simulated)
             >>> print(f"RMSE: {rmse_value:.4f}")
-            RMSE: 0.1483
+            RMSE: 0.1732
 
             ```
         - Using numpy arrays:

src/statista/distributions.py

@@ -2752,9 +2752,9 @@ def pdf(
         Args:
             parameters (Dict[str, float], optional):
                 if not provided, the parameters provided in the class initialization will be used.
-                - loc: [numeric]
+                - loc (numeric):
                     location parameter of the gumbel distribution.
-                - scale: [numeric]
+                - scale (numeric):
                     scale parameter of the gumbel distribution.
                 ```python
                 {"loc": val, "scale": val}. default is None.

src/statista/plot.py

@@ -9,6 +9,7 @@
 from matplotlib.axes import Axes
 from matplotlib.figure import Figure
 
+XLABEL = "Actual data"
 
 class Plot:
     """Visualization utilities for statistical distributions and analyses.
@@ -61,8 +62,8 @@ def pdf(
         qx: np.ndarray,
         pdf_fitted: Union[np.ndarray, list],
         data_sorted: np.ndarray,
-        fig_size: Tuple = (6, 5),
-        xlabel: str = "Actual data",
+        fig_size: Tuple[float, float] = (6, 5),
+        xlabel: str = XLABEL,
         ylabel: str = "pdf",
         fontsize: int = 11,
     ) -> Tuple[Figure, Axes]:
@@ -159,7 +160,7 @@ def cdf(
         data_sorted: np.ndarray,
         cdf_weibul: np.ndarray,
         fig_size: Tuple[float, float] = (6, 5),
-        xlabel: str = "Actual data",
+        xlabel: str = XLABEL,
         ylabel: str = "cdf",
         fontsize: int = 11,
     ) -> Tuple[Figure, Axes]:
@@ -264,7 +265,7 @@ def details(
         cdf_fitted: Union[np.ndarray, list],
         cdf: Union[np.ndarray, list],
         fig_size: Tuple[float, float] = (10, 5),
-        xlabel: str = "Actual data",
+        xlabel: str = XLABEL,
         ylabel: str = "cdf",
         fontsize: int = 11,
     ) -> Tuple[Figure, Tuple[Axes, Axes]]: