Metadata-Version: 2.1
Name: statista
Version: 0.6.0
Summary: statistics package
Home-page: https://github.com/Serapieum-of-alex/statista
Author: Mostafa Farrag
Author-email: moah.farag@gmail.come
License: GNU General Public License v3
Keywords: statistics,distributions,extreme-value-analysis,probability,sensitivity-analysis
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Description-Content-Type: text/markdown
License-File: LICENSE.md
License-File: AUTHORS.rst
Requires-Dist: loguru>=0.7.2
Requires-Dist: matplotlib>=3.9.0
Requires-Dist: numpy>=2.0.1
Requires-Dist: pandas>=2.1.0
Requires-Dist: pip>=23.2.1
Requires-Dist: scikit-learn>=1.5.1
Requires-Dist: scipy>=1.14.0
Provides-Extra: dev
Requires-Dist: black>=24.4.2; extra == "dev"
Requires-Dist: darglint>=1.8.1; extra == "dev"
Requires-Dist: flake8-bandit>=4.1.1; extra == "dev"
Requires-Dist: flake8-bugbear>=24.4.26; extra == "dev"
Requires-Dist: flake8-docstrings>=1.7.0; extra == "dev"
Requires-Dist: flake8-rst-docstrings>=0.3.0; extra == "dev"
Requires-Dist: nbval>=0.11.0; extra == "dev"
Requires-Dist: pep8-naming>=0.14.1; extra == "dev"
Requires-Dist: pre-commit>=3.7.1; extra == "dev"
Requires-Dist: pre-commit-hooks>=4.6.0; extra == "dev"
Requires-Dist: pytest>=8.2.2; extra == "dev"
Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
Requires-Dist: reorder-python-imports>=3.13.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: easydev; extra == "docs"
Requires-Dist: graphviz; extra == "docs"
Requires-Dist: matplotlib>=3.8.4; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: numpy>=2.0.0; extra == "docs"
Requires-Dist: numpydoc==1.1.0; extra == "docs"
Requires-Dist: pandas; extra == "docs"
Requires-Dist: pip>=21.3.1; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.15.2; extra == "docs"
Requires-Dist: sphinxcontrib-napoleon; extra == "docs"
Requires-Dist: typing-extensions==3.10.*; extra == "docs"

[![Python Versions](https://img.shields.io/pypi/pyversions/statista.png)](https://img.shields.io/pypi/pyversions/statista)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/MAfarrag/earth2observe.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/MAfarrag/earth2observe/context:python)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/MAfarrag/earth2observe.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/MAfarrag/earth2observe/alerts/)


[![codecov](https://codecov.io/gh/Serapieum-of-alex/statista/branch/main/graph/badge.svg?token=GQKhcj2pFK)](https://codecov.io/gh/Serapieum-of-alex/statista)
![GitHub last commit](https://img.shields.io/github/last-commit/MAfarrag/statista)
![GitHub forks](https://img.shields.io/github/forks/MAfarrag/statista?style=social)
![GitHub Repo stars](https://img.shields.io/github/stars/MAfarrag/statista?style=social)


Current release info
====================

| 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) |

statista - Statistics package
=====================================================================
**statista** is a statistics package

statista

Main Features
-------------
  - Statistical Distributions
    - GEV
    - GUMBEL
    - Normal
    - Exponential
  - Parameter estimation methods
    - Lmoments
    - ML
    - MOM
  - One-at-time (O-A-T) Sensitivity analysis.
  - Sobol visualization
  - Statistical descriptors
  - Extreme value analysis

For the full documentation, please visit [statista documentation](https://statista.readthedocs.io/en/latest/?badge=latest)

Installing statista
===============

Installing `statista` from the `conda-forge` channel can be achieved by:

```
conda install -c conda-forge statista
```

It is possible to list all the versions of `statista` available on your platform with:

```
conda search statista --channel conda-forge
```

## Install from GitHub
to install the last development to time, you can install the library from GitHub
```
pip install git+https://github.com/MAfarrag/statista
```

## pip
to install the last release, you can use pip
```
pip install statista==0.6.0
```

Quick start
===========

```
  >>> import statista
```

[other code samples](https://statista.readthedocs.io/en/latest/?badge=latest)


=======
History
=======

0.1.0 (2022-05-24)
------------------

* First release on PyPI.

0.1.7 (2022-12-26)
------------------

* lock numpy to version 1.23.5


0.1.8 (2023-01-31)
------------------

* bump up versions


0.2.0 (2023-02-08)
------------------

* add eva (Extreme value analysis) module
* fix bug in obtaining distribution parameters using optimization method


0.3.0 (2023-02-19)
------------------

* add documentations for both GEV and gumbel distributions.
* add lmoment parameter estimation method for all distributions.
* add exponential and normal distributions
* modify the pdf, cdf, and probability plot plots
* create separate plot and confidence_interval modules.

0.4.0 (2023-11-23)
------------------

* add Pearson 3 distribution
* Use setup.py instead of pyproject.toml.
* Correct pearson correlation coefficient and add documentation .
* replace the pdf and cdf by the methods from scipy package.

0.5.0 (2023-12-11)
------------------

* Unify the all the methods for the distributions.
* Use factory design pattern to create the distributions.
* add tests for the eva module.
* use snake_case for the methods and variables.

0.6.0 (2024-08-18)
------------------

dev
"""
* Add documentations for the `distributions`, and `eva` modules.
* Add autodoc for all modules.
* Test docstrings as part of CI and pre-commit hooks.
* Test notebooks as part of CI.
* Simplify test for the distributions module

distributions
"""""""""""""
* move the `cdf` and `parameters` for all the methods to be optional parameters.
* rename `theoretical_estimate` method to `inverse_cdf`.
* All distributions can be instantiated with the parameters and/or data.
* rename the `probability_plot` method to `plot`.
* move the `confidence_interval` plot from the `probability_plot/plot` to the method `confidence_interval` and can be
    called by activating the `plot_figure=True`.

descriptors
"""""""""""
* rename the `metrics` module to `descriptors`.
