Prerequisites
=============

.. _prerequisites:

Before installing DiscoPygal, install the tools listed in this page.

General prerequisites
---------------------

For every platform, you need:

* At least 8GB of RAM, especially if you are using a virtual machine or WSL.
* Python 3.10 or newer.
* Git.
* A C++ compiler.

Installing Python and uv
------------------------

Use the shell selector below to install uv and prepare Python.

.. tabs::

    .. tab:: Bash

        .. code-block:: bash

            curl -LsSf https://astral.sh/uv/install.sh | sh
            uv python install

    .. tab:: PowerShell / pwsh

        .. code-block:: powershell

            winget install --id astral-sh.uv -e
            uv python install

Installing C++ compiler
-----------------------

.. tabs::

    .. tab:: Windows

        Install Visual Studio or Visual Studio Build Tools.

        | https://aka.ms/vs/17/release/vs_buildtools.exe
        | If you install Visual Studio Build Tools, choose Desktop development with C++.

        .. image:: ../../images/vs_tools_installer.png
            :width: 400

        Make sure to choose these components from the sidebar:

        .. image:: ../../images/components_to_vs_tools.png
            :width: 250

    .. tab:: macOS

        .. code-block:: zsh

            xcode-select --install

    .. tab:: Ubuntu

        .. code-block:: bash

            sudo apt install software-properties-common
            sudo add-apt-repository ppa:ubuntu-toolchain-r/test
            sudo apt update
            sudo apt install gcc-12 g++-12
            export CC=gcc-12
            export CXX=g++-12

Installing Git
--------------

.. tabs::

    .. tab:: Windows

        .. code-block:: powershell

            winget install --id Git.Git -e --source winget

    .. tab:: macOS

        Git is typically installed with the Xcode Command Line Tools.

        .. code-block:: zsh

            xcode-select --install
            git --version

    .. tab:: Ubuntu

        .. code-block:: bash

            add-apt-repository ppa:git-core/ppa
            apt update
            apt install git

Installing PySide6 dependencies
-------------------------------


Install PySide6 explicitly for Linux / Windows / Apple-Silicon machines


.. code-block:: bash

    uv add PySide6