.. Drone Digital Twin SDK documentation master file, created by
   sphinx-quickstart on Thu Apr  4 16:45:14 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
   
*************************************************************
Welcome to Khet-Shut: A Digital Twin SDK for Robotic Vehicles
*************************************************************

Khet-Shut and Ka
================
In ancient egyptian language, *Khet-Shut* translates to *Physical-Shadow* which is the purpose of our project. We aim to seamlessly give life to a physical-digital system for robotic vehicles.

The Project
============
Building digital twins for drones is not a trivial task and it requires a specific pipeline to be followed as well as specific hardware and software components. 
Our project aims to provide a Software Development Kit (SDK) that will help developers to build digital twins for automated vehicles whether they be robotic or aeronautic.

The project uses the concept of a dockerized private cloud to host the dashboard and the Namespace that establish the bidirectional communication aka the digital twin.

.. The technical aspects of the project is described in the :ref:`overview`

.. See the :ref:`setting_up` for more information on getting started with the SDK.

.. User Guide
.. ==================
.. See the :ref:`developer_guide` for more information on how to use the SDK.
.. figure:: /_static/ddiagram.png 
    :alt: Flow Diagram of the Project
    :align: center
    :figclass: align-center
    :class: align-center
    :width: 100%
    
    Flow Diagram of the Project

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   overview
   setting_up
   dev_guide
   examples
   errors
   faq

.. toctree::
   :maxdepth: 2
   :caption: Project Links:

   Source Code <https://github.com/ThesisG1/Digital_Twin/tree/master>
   Discord <https://discord.gg/HzBeNUZE>
   Issue Tracker <https://github.com/ThesisG1/Digital_Twin/issues>

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`