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

The installers for ImFusion Labels can be found on this page: `https://www.imfusion.com/download-imfusion-labels <https://www.imfusion.com/download-imfusion-labels>`_.

.. _python-install:

Python Support
--------------

Some features such as :ref:`algorithms` require a correctly configured Python environment.
These features are optional though and setting up Python is not required.
To configure a Python environment, we recommend to use a `Virtual Environment <https://docs.python.org/3/library/venv.html>`_.
Any existing virtual environment with the correct version of ``imfusion-sdk-labels`` can be used or you can set up a new virtual environment in the home directory using the commandline:

Linux and macOS
^^^^^^^^^^^^^^^

.. code-block:: sh

   python3 -m venv .imfusion-labels-venv
   source .imfusion-labels-venv/bin/activate
   pip install --extra-index-url=https://pypi.imfusion.com/simple imfusion-sdk-labels==1.2.0

Windows
^^^^^^^

.. code-block:: sh

   python -m venv imfusion-labels-venv
   .\imfusion-labels-venv\Scripts\activate.bat
   pip install --extra-index-url=https://pypi.imfusion.com/simple imfusion-sdk-labels==1.2.0

After starting ImFusion Labels, open the application settings and switch to the Python settings.
The virtual environment can be added by pressing the + button and selecting the python executable (e.g. ``~/.imfusion-labels-venv/bin/python`` or ``Home\imfusion-labels-venv\Scripts\python.exe``).
The settings dialog will show whether the correct version of the ``imfusion-sdk-labels`` package is installed in the selected virtual environment.

.. image:: img/python-settings.png

After changing the environment, the application has to be restarted.
If they Python integration does not work despite the correct version being installed, check the log file for further details.