Installation
============

Development environment
-----------------------

Requirements
~~~~~~~~~~~~

- Python: https://www.python.org
- Poetry: https://python-poetry.org/docs

After installing Poetry and cloning the project from `GitHub <https://github.com/tiazv/unfair-data-generator>`_, execute the following command in the root directory of the cloned project:

.. code:: sh

    poetry install

All of the project's dependencies should be installed and the project should be ready for further development. Note that Poetry creates a separate virtual environment for the project.

Development dependencies
~~~~~~~~~~~~~~~~~~~~~~~~

List of unfair-data-generator's dependencies:

+----------------------+----------------------+
| Package              | Version              |
+======================+======================+
| matplotlib           | ~3.7.5               |
+----------------------+----------------------+
| numpy                | ^1.26.0              |
+----------------------+----------------------+
| pandas               | ^2.3.1               |
+----------------------+----------------------+
| scikit-learn         | ~1.3.2               |
+----------------------+----------------------+
| sphinx               | ^5.0                 |
+----------------------+----------------------+
| sphinx-rtd-theme     | ^1.0.0               |
+----------------------+----------------------+