Install
=======

The pyRat_ wheel can easily be installed into an Python_ environment
with a version and architecture matching that of the wheel.

1. Create a Python virtual environment with
   matching Python_ version and activate it:

-----

For Windows:

.. code-block:: powershell

    python -m venv venv
    .\venv\Scripts\activate

For Linux:

.. code-block:: bash

    python -m venv venv
    source ./venv/bin/activate

-----

This can also be done with UV_ as ``uv venv venv``.

Virtual environments allow to isolate
libraries used by the pyRat_ Python_ module.

Installing pyRat_ in global Python_ might conflict
with libraries from the Rat-GUI_ software.

- Install the wheel into the virtual environment:

.. code-block:: bash

    python -m pip install ./pyrat-....whl

- Check installation via CLI:

.. code-block:: bash

    python -m pyrat --version

This should print the version of pyRat_ tied to the wheel
use for installation into the virtual environment.

.. Links
.. _Project-Rat: https://gitlab.com/project-rat
.. _pybind11: https://github.com/pybind/pybind11
.. _pyRat: https://gitlab.com/project-rat-extras/pyrat
.. _Python: https://www.python.org/
.. _Python wheels: https://pythonwheels.com/
.. _Python wheel: https://pythonwheels.com/
.. _Rat-Containers: https://gitlab.com/project-rat-extras/rat-containers
.. _Rat-GUI: https://rat-gui.com/
.. _Rat-Models: https://gitlab.com/project-rat/rat-models
.. _Rat-vcpkg: https://gitlab.com/project-rat-extras/rat-vcpkg
.. _UV: https://github.com/astral-sh/uv