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

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

We offer two different ways of obtaining the QMENTA SDK:

    * **Install the SDK** to a Debian based container (for already containerized solutions).
    * Use our off-the-shelf **base images** to insert your algorithms (for users new to Docker).

Install Python Package
----------------------

In order to get the latest version of our SDK installer and install it in your container, you can follow the sequence of commands shown below:

.. note:: These commands are expected to be executed on the Debian-based container.

#. Check that your container meets the requirements:

    * A Debian-based distribution (for instance Ubuntu).
    * Python 2.7 or 3.5+.
    * Python pip.
    * GNU WGet

    If your container is Debian-based, you can install the required programs by running:

    .. code-block:: bash

        apt install python python-pip wget

#. Install the |QMENTA SDK python library| **inside your container**:

    .. code-block:: bash

        pip install qmenta-sdk-lib

#. Create an empty entrypoint.sh passing the path where you want it to be generated and the paths to the directory where the python tool script will be located (it automatically updates the PYTHONPATH variable).

    .. code-block:: bash

        python -m qmenta.sdk.make_entrypoint ./entrypoint.sh /root/

.. External links

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

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

Extend Docker Image
-------------------

We provide several images that you can get to start implementing your own tools. These images contain a working version of Ubuntu with our SDK (a preinstalled python library).

#. Make sure you have Docker in your computer (you can download it from |here|). Docker supports most operative systems (Mac, Windows, Ubuntu, Debian, CentOS, Fedora).

#. Choose the base image that suits you better:

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

        ============================    =======     ==========================================================================================
        Image name                      Size        Contents
        ============================    =======     ==========================================================================================
        |qmentasdk/minimal|             0.37 GB      Ubuntu 18.04 image with the bare minimum to run in our platform (our SDK and Python 3.6).
        |qmentasdk/minimalpy2|          0.37 GB      Ubuntu 18.04 image with the bare minimum to run in our platform (our SDK and Python 2.7).
        |qmentasdk/mrtrix_ants|         6.47 GB      Ubuntu 14.04 image, with MRtrix3.0 and ANTs 2.1.0 installed.
        |qmentasdk/matlab_r2016a|       7.48 GB      Ubuntu 14.04 image with MATLAB RTC R2015a installed (more on :doc:`../examples`).
        |qmentasdk/matlab_r2017a|       9.64 GB      Ubuntu 14.04 image with MATLAB RTC R2017a installed (more on :doc:`../examples`).
        ============================    =======     ==========================================================================================

#. Download an image to your computer:

    `docker pull qmentasdk/image_name:version`

#. Check that you have indeed downloaded the image by running:

    `docker images`

If you require any special requirement that cannot be fulfilled by any of the former base images, please do not hesitate to contact us at sdk@qmenta.com.

.. External links

.. |here| raw:: html

    <a href="https://www.docker.com/get-docker" target="_blank">here</a>

.. |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>

.. |qmentasdk/mrtrix_ants| raw:: html

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

.. |qmentasdk/matlab_r2016a| raw:: html

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

.. |qmentasdk/matlab_r2017a| raw:: html

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