.. SU2 DataMiner documentation master file, created by
   sphinx-quickstart on Mon May 19 19:53:37 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

SU2 DataMiner
=============

SU2 DataMiner is an open-source, python-based software library for data-driven fluid modeling applications in `SU2`_. 
The software currently supports laminar combustion and real-gas applications where the thermodynamic state of the fluid is evaluated by deep, dense, feed-forward multi-layer perceptrons trained 
using physics-informed machine learning methods. 

.. note::

   This project is under active development.

.. toctree::
   Setup
   Development
   :maxdepth: 1
   :caption: Contents:

.. _SU2 : https://github.com/su2code/SU2.git 


.. toctree::
   Tutorials/create_configs.rst 
   :maxdepth: 2
   :caption: Tutorials: 


.. toctree::
   documentation/index.rst
   :caption: Documentation
   :maxdepth: 2


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

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