.. image:: /logo_sarus_small.png
  :width: 100
  :alt: Sarus Logo

===============================
Welcome to Sarus documentation!
===============================

*Last update date:   January, 2024*

Sarus provides a faster and safer data access for analytics and AI.
With Sarus, data analysts and scientists leverage data they cannot see and produce
impactful results instantly, with their usual tools,
in full regulatory compliance and maximum security.

This documentation presents main Sarus concepts and provides guides to install Sarus
in your environment,
prepare datasets and run Analytics and ML tasks on protected data through the Sarus
API, python SDK or BI connector.


Quickly getting started
=======================

If you already have Sarus installed and are eager to get started, we recommend to jump straight into our :doc:`Quickstart Tutorial <quickstart_tutorial>` and follow the steps described there.

In a few words, you will:

.. image:: /howitworks.png
  :width: 700
  :alt: How it works workflow


Table of contents
=================

- INTRODUCTION TO SARUS

  - :doc:`What is Sarus <sarus_intro>`
  - :doc:`Key Concepts <sarus_concepts>`
  - :doc:`Differential Privacy <differential_privacy>`
  - :doc:`Privacy-safe Evaluation <privacy_safe_evaluation>`

- INTEGRATIONS

  - :doc:`MongoDB <mongodb>`
  - :doc:`AWS Redshift <aws_redshift>`
  - :doc:`Google BigQuery <google_bigquery>`
  - :doc:`Azure Synapse <azure_synapse>`

- USER GUIDE

  - :doc:`Installation on a single server <install>` 
  - :doc:`Installation on Kubernetes <install_k8s>` 
  - :doc:`Quickstart tutorial <quickstart_tutorial>`
  - :doc:`Application administration <User Guide/application_administration>` 
  - :doc:`Data administration <User Guide/data_administration>`
  - :doc:`Data Science & AI <User Guide/data_science_&_AI>`
  
    - :doc:`List of supported transformations <sdk_documentation/transformations_list>`
  - :doc:`Examples <examples>`
  - :doc:`Introduction to main Sarus concepts <sarus_concepts>`
  - `API reference <https://admin.sarus.tech:5000/apidocs/#/>`_
  - :doc:`Support <support>`


.. toctree::
    :hidden:
    :maxdepth: 2
    :caption: Introduction to Sarus
    
      What is Sarus? <sarus_intro>
      Key concepts <sarus_concepts>
      Differential Privacy <differential_privacy>
      Privacy-safe Evaluation <privacy_safe_evaluation>

    

.. toctree::
    :hidden:
    :maxdepth: 2
    :caption: INTEGRATIONS

    MongoDB <mongodb>
    AWS Redshift <aws_redshift>
    Google BigQuery <google_bigquery>
    Azure Synapse <azure_synapse>

.. toctree::
    :hidden:
    :maxdepth: 3
    :caption: User Guide

    Installation on a single server <install>
    Installation on Kubernetes <install_k8s>
    Quickstart tutorial <quickstart_tutorial>
    Application administration <User Guide/application_administration>
    Data administration <User Guide/data_administration>
    Data Science & AI <User Guide/data_science_&_AI>
    Examples <examples>
    API reference <https://admin.sarus.tech:5000/apidocs/#/>
    Release notes <https://storage.googleapis.com/eu.artifacts.sarus-mvp.appspot.com/releases-doc/RELEASES.md>
    support


For further information about Sarus, check out `our website <https://www.sarus.tech>`_!

..
    Copyright 2022 Sarus Technologies. All rights reserved.