pysatl-criterion 1.0.0

Package with statistic criteria for PySATL

PySATL Criterion

This repository contains a collection of Python scripts and modules for performing various statistical tests. These tests are designed to help you analyze data, make inferences, and draw conclusions based on statistical methods. The repository is organized to be easy to use, modular, and extensible.

Installation

To use this repository, you need to have Python 3.9 or later installed on your system. You can install the required dependencies by following these steps:

Clone the repository:

git clone https://github.com/PySATL/pysatl-criterion.git

Install dependencies:

poetry install

You're all set! You can now import and use the statistical tests in your Python scripts.

PySATL Criterion module usage example:

Statistic calculation example:

# import needed criterion from pysatl_criterion
from pysatl_criterion.statistics import KolmogorovSmirnovNormalityGofStatistic


# make a criterion object
statistic = KolmogorovSmirnovNormalityGofStatistic(mean=0, var=1)

# initialize test data
x = [0.1, 0.7, 0.5, 0.3]

# then run algorithm
result = statistic.execute_statistic(x)

# print the results
print(f"Statistic result: {result}")
# output:
# Statistic result: 0.539827837277029

Documentation

We invite you to read the bot documentation to ensure you understand how the PySATL Criterion lib is working.

Please find the complete documentation on the PySATL Criterion website.

Support

Bugs / Issues

If you discover a bug in the PySATL criterion lib, please search the issue tracker first. If it hasn't been reported, please create a new issue and ensure you follow the template guide so that the team can assist you as quickly as possible.

For every issue created, kindly follow up and mark satisfaction or reminder to close issue when equilibrium ground is reached.

--Maintain github's community policy--

Feature Requests

Have you a great idea to improve the bot you want to share? Please, first search if this feature was not already discussed. If it hasn't been requested, please create a new request and ensure you follow the template guide so that it does not get lost in the bug reports.

Pull Requests

Feel like the PySATL criterion lib is missing a feature? We welcome your pull requests!

Please read the Contributing document to understand the requirements before sending your pull-requests.

Coding is not a necessity to contribute - maybe start with improving the documentation? Issues labeled good first issue can be good first contributions, and will help get you familiar with the codebase.

Note before starting any major new feature work, please open an issue describing what you are planning to do. This will ensure that interested parties can give valuable feedback on the feature, and let others know that you are working on it.

Important: Always create your PR against the develop branch, not stable.

Software requirements

• Python >= 3.9
• poetry
• git
• virtualenv (Recommended)

Development

Install requirements

poetry install --with dev

Pre-commit

Install pre-commit hooks:

poetry run pre-commit install

Starting manually:

poetry run pre-commit run --all-files --color always --verbose --show-diff-on-failure

License

This project is licensed under the terms of the Apache License 2.0 license. See the LICENSE for more information.