.. raw:: html
   :file: ../utils/google_analytics_snippet.html

Install the QMENTA SDK
======================

For maximum control over dependencies, we recommend creating a dedicated Python environment. Follow these steps to set up the QMENTA SDK on a Debian-based system:

#. **System Requirements**:
    
    * Debian-based Linux distribution (Ubuntu, Debian, etc.)
    * Python 3.10 or higher
    * pip (Python package installer)
    
    Install basic requirements on Debian/Ubuntu:

    .. code-block:: bash

        sudo apt update
        sudo apt install python3 python3-pip python3-venv python3-tk

#. **Create a Python Virtual Environment** (Recommended):
    
    Creating an isolated environment helps manage dependencies and avoids conflicts with system packages.

    .. code-block:: bash

        # Create a new virtual environment
        python3 -m venv ~/qmenta_env
        
        # Activate the environment
        source ~/qmenta_env/bin/activate
        
        # Your prompt should now show (qmenta_env)

#. **Install the QMENTA SDK Python Library**: |QMENTA SDK python library| 

    .. code-block:: bash

        # Make sure your environment is activated
        pip install --upgrade pip
        pip install qmenta-sdk-lib

#. **Verify Installation**:

    .. code-block:: bash

        python -c "import qmenta.sdk; print('QMENTA SDK installed successfully')"

#. **Install Docker**: (if not already installed):

    Follow the official Docker installation guide for your system: |docker_install|


.. External links

.. |QMENTA SDK python library| raw:: html

    <a href="https://pypi.org/project/qmenta-sdk-lib/" target="_blank">QMENTA
    SDK python library</a>

.. |docker_install| raw:: html

    <a href="https://docs.docker.com/engine/install/" target="_blank">Docker Install Guide</a>

.. only:: internal_docs

    .. 
        Docker base images are temporarily unavailable. This section is hidden 
        from public documentation but preserved for internal reference.

    Using Docker Base Images
    ------------------------

    We provide ready-to-use Docker images that include the QMENTA SDK and common dependencies:

    #. **Install Docker** (if not already installed):

        Follow the official Docker installation guide for your system: |docker_install|

    #. **Available Base Images**:

        .. table::
            :widths: 7, 3, 10

            +-----------------------------+---------+---------------------------------------------+
            | Image name                  | Size    | Contents                                    |
            +=============================+=========+=============================================+
            | |qmentasdk/minimal|         | ~0.5 GB | Ubuntu-based image with                     |
            |                             |         | Python 3.8+ and the QMENTA SDK              |
            |                             |         | pre-installed.                              |
            +-----------------------------+---------+---------------------------------------------+
            | |qmentasdk/minimalpy2|      | ~0.5 GB | Ubuntu-based image with                     |
            |                             |         | Python 2.7 and the QMENTA SDK               |
            |                             |         | (legacy support).                           |
            +-----------------------------+---------+---------------------------------------------+

    #. **Pull and Use a Base Image**:

        .. code-block:: bash

            # Pull the minimal Python 3 image
            docker pull qmentasdk/minimal:latest
            
            # Run a container interactively
            docker run -it --rm qmentasdk/minimal:latest /bin/bash
            
            # Check Python and SDK availability
            python -c "import qmenta.sdk"

    #. **Extend the Base Image**:

        Create a Dockerfile that builds upon our base image:

        .. code-block:: dockerfile

            FROM qmentasdk/minimal:latest
            
            # Install additional dependencies
            RUN apt update && apt install -y \
                your-package-1 \
                your-package-2
            
            # Install Python packages
            RUN pip install --no-cache-dir \
                numpy \
                scipy \
                your-python-package
            
            # Copy your tool scripts
            COPY your_tool_scripts /opt/tool/
            
            # Set entrypoint
            COPY entrypoint.sh /entrypoint.sh
            RUN chmod +x /entrypoint.sh
            ENTRYPOINT ["/entrypoint.sh"]

    .. note:: For specialized requirements not covered by our base images, please contact us at sdk@qmenta.com.

    .. External links

    .. |qmentasdk/minimal| raw:: html

        <a href="https://hub.docker.com/r/qmentasdk/minimal/tags/"
        target="_blank">qmentasdk/minimal</a>

    .. |qmentasdk/minimalpy2| raw:: html

        <a href="https://hub.docker.com/r/qmentasdk/minimalpy2/tags/"
        target="_blank">qmentasdk/minimalpy2</a>