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

Welcome to the QMENTA SDK documentation!
==========================================

Introduction
------------

The |qmenta_platform| provides a unified solution for data management, processing and visualisation. 
The **analyses** (medical imaging processing tools) are executed on the hybrid cloud infrastructure as 
**Docker containers** and treated as black boxes that communicate with the platform using our SDK.

.. image:: ./images/image_execution_diagram.webp
    :align: center
    :width: 350 px

A **simple Python program** connects the |qmenta_platform| with any third-party program. This typically involves 
fetching the input data, starting the binaries or scripts and uploading the result files in a compartmentalized, 
traceable and secure computing environment.

.. image:: ./images/platform_analysis_overview.webp
   :align: center
   :width: 700 px

Any data uploaded to the platform can be used for analysis with a simple step, 
and the resulting files can be managed and visualized within the same platform website.

.. image:: ./images/start_analysis_settings.webp
   :align: center
   :width: 700 px

In addition, tools can also be seamlessly customized to include external parameters using GUI elements that provide 
an easy way for users to choose between different options and tune the execution flow of the analyses.

.. External Links

.. |qmenta_platform| raw:: html

   <a href="https://client.qmenta.com" target="_blank">QMENTA Platform</a>

Tool Maker guide
-----------------

We invite you to get started with the QMENTA SDK by reading this guide introducing the QMENTA Tool Maker
to integrate your first algorithm in the QMENTA platform.

.. toctree::
   :maxdepth: 2

   guides_docs/install
   guides_docs/develop_images
   guides_docs/tool_maker


Tool tutorial
---------------

If you are looking for more in-depth information about specific stages in the tool development process with the
QMENTA SDK, we recommend you to read the following documents.

.. toctree::
   :maxdepth: 2

   Tool tutorial <tool_tutorial>

The following pages contain information that, while still functional, is considered outdated. These sections provide
guidance on integrating a tool into the QMENTA Platform; however, they require manual creation of all necessary files.
It is now recommended to utilize the QMENTA Tool Maker, which automates this process. Nevertheless, for those interested
in exploring the underlying details, these pages remain available for reference.

.. toctree::
   :maxdepth: 2

   advanced

Examples
--------

You can also find concrete examples of how the QMENTA SDK can be used in a variety of tool development scenarios.

.. note::
   This examples are not using QMENTA Tool Maker. You can find one example here:
   <a href="https://github.com/QMENTA/qmenta-sdk-tool-maker-example" target="_blank">QMENTA SDK Tool maker Example</a>


.. toctree::
    :maxdepth: 2

    examples

API Reference
-------------

In the API reference you can find detailed documentation about the attributes and methods of the two main classes 
available in the SDK: `qmenta.sdk.context.AnalysisContext` and `qmenta.sdk.context.File`.

.. toctree::
    :maxdepth: 2

    api_reference

Community
---------

Lastly, we invite you to join the conversation and get support from fellow developers and QMENTA representatives 
in the Brain Innovation Hub.

.. toctree::
   :maxdepth: 1

   Join the Community <community>

.. TODO: Decide what to do with this notes
.. .. note::
   Feel free to contact us if you have any doubt or request at sdk@qmenta.com! We are happy to hear from you and expand the capabilities of the platform to fit new useful requirements.
.. .. note::
   In order to add tools to the QMENTA platform you need to have `developer` privileges. If you are interested in this feature, please contact us at info@qmenta.com.