.. _Palette requirements:

System Requirements
-------------------

This section provides a detailed overview of the system and software requirements needed to 
successfully install and use the Palette software.

CPU, Memory, and Storage
########################

The application requires an |var_palette_reqs_system_arch| machine with Admin privileges:

- |var_palette_reqs_system_num_cpu_cores|
- |var_palette_reqs_system_ram_amount|
- |var_palette_reqs_system_storage_amount|
- |var_palette_reqs_system_storage_type|

Verify that your system meets these requirements.

Operating Systems
#################

The Palette software supports the following operating systems:

- |var_palette_reqs_os_ubuntu_versions|
- |var_palette_reqs_os_windows_versions|

MLSoC Firmware
##############

Each version of the Palette software is compatible with a specific firmware version on the MLSoC device.

- Palette version: |var_palette_reqs_version|
- MLSoC device firmware version: |var_palette_reqs_mlsoc_fw_version|

Please refer to the :ref:`Firmware and Board Software Update` of this guide to learn how to check
and update your firmware version. Additionally, see the details of :ref:`Initial Board Setup` in 
this guide.

Docker Engine
#############

The Palette software requires the following Docker Engine versions:

- |var_palette_reqs_docker_ubuntu_versions|
- |var_palette_reqs_docker_windows_versions|

 .. note::
    You can check your Docker Engine version by running:

    .. code-block:: console

        sima-user@sima-user-machine:~$ docker --version
        Docker version 24.0.6, build ed223bc

    You must also add the current user to the Docker group. For more information, please see the
    Palette installation docker note under: :ref:`docker-group-warning`

Python
######

The Palette software installer and other tools depend on the following Python versions:

- |var_palette_reqs_python_versions|

 .. note::
    You can check your Python version by running:

    .. code-block:: console

        sima-user@sima-user-machine:~$ python3 --version
        Python 3.9.12

Ports
#####

The Palette software makes use of and requires the following ports to be open and unused:

- |var_palette_reqs_unused_ports| - This port is used for visualization functions and is
  configurable in the Palette :code:`install.py` script.

Firewall Settings
#################

Ensure that your firewall settings do not block the following:

- |var_palette_reqs_firewall_docker|
- |var_palette_reqs_firewall_ssh|
- |var_palette_reqs_firewall_port_access| (or port chosen in the :code:`install.py` script as noted below)

.. note::
    Use your system's firewall configuration to verify that this port is open. If this port is 
    not open, please update the :code:`install.py` script of Palette (line 25) and enter a new 
    open/available port prior to installing Palette:

    .. code-block:: python3

        PORT = 80  # update this to any open/allowed port prior to install

SSH Capabilities
################

Ensure that your system is configured to allow SSH connections for remote management.
Verify SSH access by attempting to connect to your :code:`localhost`:

.. code-block:: console

    sima-user@sima-user-machine:~$ which ssh
    /usr/bin/ssh
    sima-user@sima-user-machine:~$ ssh localhost

If you encounter any issues, review your SSH server configuration.