restructure the distrubutions module

[MAfarrag]

Description

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.

• Fixes # (issue)

Type of change

Check relevant points.

• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

• Please describe the tests that you ran to verify your changes.

• Provide instructions so we can reproduce.

• Please also list any relevant details for your test configuration

• TestAbstractDistribution.test_abstract_distribution

• TestGumbel.test_create_instance_with_wrong_data_type

• TestGumbel.test_create_instance_with_wrong_parameter_type

• TestGumbel.test_random

• TestGEV.test_random

Checklist:

• updated version number in setup.py/pyproject.toml
• updated environment.yml and the lock file
• added changes to History.rst
• updated the latest version in README file
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[codecov]

Codecov Report

Attention: Patch coverage is 52.33645% with 51 lines in your changes missing coverage. Please review.

Project coverage is 58.05%. Comparing base (b3a7525) to head (d8f6b7d).

Files	Patch %	Lines
statista/sensitivity.py	0.00%	26 Missing ⚠️
statista/parameters.py	60.71%	11 Missing ⚠️
statista/tools.py	46.66%	8 Missing ⚠️
statista/descriptors.py	0.00%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #91      +/-   ##
==========================================
+ Coverage   56.35%   58.05%   +1.69%     
==========================================
  Files           9        9              
  Lines        1306     1385      +79     
==========================================
+ Hits          736      804      +68     
- Misses        570      581      +11     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.