.. 
   GEMINI documentation master file, created by
   sphinx-quickstart on Wed May  3 17:46:45 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to GEMINI's technical user manual!
==============================================

.. note::

   This project is under active development.


This is the main landing page for the technical user manual of the GEMINI digital twin framework for geothermal assets. As the name implies, the technical user manual is aimed at users of the GEMINI framework with a technical understanding of geothermal systems, such as operators and engineers. The manual gives an overview on the structure of the GEMINI platform (:numref:`about-gemini`), an introduction to getting started with the platform (:numref:`getting-started`), and a guide to setting up project (:numref:`system-setup`). In addition, each individual application or module will have its own step-by-step manual instructing a user on how to use it (:numref:`applications-section` respectively). Finally, the glossary (:numref:`gemini-glossary`) gives the definitions of all key terms used throughout this manual and in the platform itself.


.. toctree::
    :maxdepth: 2
    :numbered:
    :caption: Table of Content

    index_about_gemini
    index_getting_started
    index_setup
    index_applications
    glossary


..
   Indices and tables
   ==================
   * :ref:`genindex`
   * :ref:`modindex`
   * :ref:`search`


Contact
----------------------------------
The GEMINI platform and its various functionalities has been jointly developed by TNO, Well Engineering Partners, and Helin.

For technical questions about the platform itself, please contact Ryvo Octaviano from TNO (ryvo.octaviano@tno.nl).

For questions or suggestions about this technical user manual, please contact Jonah Poort from TNO (jonah.poort@tno.nl).


Acknowledgements
----------------------------------

This project is sponsored by the `Nieuwe Warmte Nu <https://nwn.nu/projecten/innovaties/datagedreven-optimalisatie-aardwarmte-systemen/>`_ program under innovation: Datagedreven optimalisatie aardwarmtesystemen.

Main partners: `TNO <https://www.tno.nl/en>`_, `Well Engineering Partners (WEP) <https://wellengineeringpartners.com/>`_, `Helin <https://www.helindata.com/>`_, `Aardyn <https://www.aardyn.nl/>`_, and `HVC <https://www.hvcgroep.nl/>`_.