👍🎉 First off, thanks for taking the time to contribute! 🎉👍
This project and everyone participating in it is governed by the NiaARM Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to iztok.fister1@um.si.
Before creating bug reports, please check existing issues list as you might find out that you don't need to create one. When you are creating a bug report, please include as mAll details as possible in the issue template.
Open new issue using the feature request template.
Fill in the pull request template and make sure your code is documented.
After installing uv and cloning the project from GitHub, you should run the following command from the root of the cloned project:
uv sync --devAll the project's development dependencies should be installed and the project ready for further development.
| Package | Version | Platform |
|---|---|---|
| niapy | >=2.6.1 | All |
| numpy | >=2.3.5 | All |
| pandas | >=2.3.3 | All |
| nltk | >=3.9.2 | All |
| scikit-learn | >=1.8.0 | All |
| plotly | >=6.5.0 | All |
| Package | Version | Platform |
|---|---|---|
| pytest | >=9.0.0 | All |
| pytest-cov | >=7.0.0 | All |
| pytest.randomly | >=4.0.1 | All |
| pre-commit | >=4.5.0 | All |
| ruff | >=0.14.9 | All |
| Package | Version | Platform |
|---|---|---|
| sphinx | >=8.2.3 | All |
| sphinx-rtd-theme | >=3.0.2 | All |
| sphinxcontrib-bibtex | >=2.6.5 | All |
Manually run the tests:
uv run pytestBuild the documentation:
uv sync --group docs
uv run sphinx-build ./docs ./docs/_build