General documentation update

EvertBunschoten · EvertBunschoten · commit d6e4818274f3 · 2026-04-14T10:26:43.000+02:00
diff --git a/Documentation/source/Config.rst b/Documentation/source/Config.rst
diff --git a/Documentation/source/Setup.rst b/Documentation/source/Setup.rst
@@ -3,7 +3,7 @@
 Set-up and Requirements
 =======================
 
-*SU2 DataMiner* is an open-source, python-based software suite that is available on `GitHub <https://github.com/Propulsion-Power-TU-Delft/SU2_DataMiner.git>`_. 
+*SU2 DataMiner* is an open-source, python-based software suite that is available on `GitHub <https://github.com/su2code/SU2_DataMiner.git>`_. 
 
 .. important::
 
@@ -32,7 +32,7 @@ The *SU2 DataMiner* source code can be downloaded from GitHub by cloning the rep
 
 .. code-block::
 
-    >>> git clone https://github.com/Propulsion-Power-TU-Delft/SU2_DataMiner.git <PATH_TO_SOURCE>
+    >>> git clone https://github.com/su2code/SU2_DataMiner.git <PATH_TO_SOURCE>
 
 
 where `<PATH_TO_SOURCE>` refers to the target location where the *SU2 DataMiner* source code will be stored. 
diff --git a/Documentation/source/Tutorials/FGM/index.rst b/Documentation/source/Tutorials/FGM/index.rst
@@ -0,0 +1,7 @@
+Tutorials for Flamelet-Generated Manifolds
+==========================================
+
+.. toctree::
+   methane_flamelets.rst
+   :maxdepth: 1
+   
diff --git a/Documentation/source/Tutorials/FGM/methane_flamelets.rst b/Documentation/source/Tutorials/FGM/methane_flamelets.rst
@@ -0,0 +1,18 @@
+.. sectionauthor:: Evert Bunschoten
+
+.. _tutorial_methane_flamelets:
+
+
+
+Generating a methane flamelet manifold 
+======================================
+
+This tutorial shows how to generate a manifold of methane-air flamelets using *SU2 DataMiner*. 
+The manifold contains adiabatic flamelets, burner-stabilized flamelets, and chemical equilibrium data generated for equivalence ratios between 0.8 and 1.2.
+
+
+.. contents:: :depth: 2
+
+
+Set-up
+------
diff --git a/Documentation/source/Tutorials/NICFD/index.rst b/Documentation/source/Tutorials/NICFD/index.rst
@@ -0,0 +1,7 @@
+Tutorials for Non-Ideal Compressible Fluid Dynamics
+===================================================
+
+.. toctree::
+   tablegeneration
+   :maxdepth: 1
+   
diff --git a/Documentation/source/Tutorials/SU2DataMiner_logo.png b/Documentation/source/Tutorials/SU2DataMiner_logo.png
diff --git a/Documentation/source/Tutorials/create_configs.rst b/Documentation/source/Tutorials/create_configs.rst
@@ -1,3 +1,7 @@
+.. _tutorialconfigs:
+
+.. sectionauthor:: Evert Bunschoten 
+    
 Creating SU2 DataMiner Configurations
 =====================================
 
diff --git a/Documentation/source/Tutorials/tutorial_template.rst b/Documentation/source/Tutorials/tutorial_template.rst
@@ -0,0 +1,58 @@
+.. _tutorial_label: 
+
+.. sectionauthor:: your name <email/contact>
+
+Tutorial Template 
+=================
+
+
+Use this file as a template for writing your own tutorial when creating new functionalities in SU2 DataMiner. Copy this file to the folder of the respective category and include the file name in the toctree of the ``index.rst`` file. 
+
+Introduction text in which you describe the goal of this tutorial. Create hyperlinks to other tutorials and documentation with ``:ref:`this command <DOCUMENT LABEL>``.
+For example, :ref:`this page<installation>` leads to the installation instructions page. Consult the `Sphinx documentation page <https://www.sphinx-doc.org/en/master/index.html>`_ for formatting documentation.
+You can also add images and reference them with :ref:`hyperlinks <link_to_image>`.
+
+
+.. contents:: :depth: 2
+
+
+Step 1:
+-------
+
+Some information on how to get started. 
+
+.. code-block::
+
+    >>> Explain your setup with code blocks or command line instructions.
+
+
+.. code-block::
+
+    #!/usr/bin/env python3
+    print(Or code snippets.)
+
+
+Step 2:
+-------
+
+
+
+.. image:: /Tutorials/SU2DataMiner_logo.png
+   :height: 200 px
+   :width: 200 px
+   :scale: 50 %
+   :alt: this is a detailed caption of the image
+   :align: left
+   :loading: embed
+
+
+and some text here
+
+Step 3:
+-------
+
+
+.. _literature_link_1:
+
+
+.. _literature_link_2:
diff --git a/Documentation/source/Tutorials/tutorials.rst b/Documentation/source/Tutorials/tutorials.rst
@@ -0,0 +1,10 @@
+Tutorials
+=========
+
+.. toctree::
+   create_configs
+   FGM/index
+   NICFD/index
+   tutorial_template
+   :maxdepth: 1
+   
diff --git a/Documentation/source/documentation/configs/Config_FGM.rst b/Documentation/source/documentation/configs/Config_FGM.rst
@@ -299,7 +299,7 @@ The composition of the output groups can be manually adapted and accessed with t
 
 .. autofunction:: Common.DataDrivenConfig.Config_FGM.AddOutputGroup
 
-.. autofunction:: Common.DataDrivenConfig.Config_FGM.DefineOutputGroup
+.. autofunction:: Common.DataDrivenConfig.Config_FGM.EditOutputGroup
 
 .. autofunction:: Common.DataDrivenConfig.Config_FGM.RemoveOutputGroup
 
diff --git a/Documentation/source/documentation/tabulation/FGM.rst b/Documentation/source/documentation/tabulation/FGM.rst
diff --git a/Documentation/source/index.rst b/Documentation/source/index.rst
@@ -24,7 +24,7 @@ using physics-informed machine learning methods.
 
 
 .. toctree::
-   Tutorials/create_configs.rst 
+   Tutorials/tutorials
    :maxdepth: 2
    :caption: Tutorials: 
 
