diff --git a/_config.yml b/_config.yml index f09ad726..95970070 100644 --- a/_config.yml +++ b/_config.yml @@ -76,6 +76,16 @@ defaults: sectionid: vandv seo: type: "WebPage" + +- scope: + path: _su2gui + type: su2gui + values: + layout: su2gui + sectionid: su2gui + seo: + type: "WebPage" + collections: docs: permalink: /:collection/:path/ @@ -89,6 +99,9 @@ collections: vandv: permalink: /:collection/:path/ output: true + su2gui: + permalink: /:collection/:path/ + output: true posts: permalink: /blog/:year/:month/:day/:title/ output: true diff --git a/_data/su2gui.yml b/_data/su2gui.yml new file mode 100644 index 00000000..c822b29e --- /dev/null +++ b/_data/su2gui.yml @@ -0,0 +1,19 @@ +- title: Introduction to SU2GUI + su2gui: + - Introduction + - Quick-Start + +- title: Installation + su2gui: + - Installation + +- title: User Guide + su2gui: + - Terminal-Initialization + - Manage-Cases + - Mesh-File + - configurations + - Initialization + - Logs-Errors + - Result-Analysis + - Supported-Functionalities \ No newline at end of file diff --git a/_docs_v7/Container-Development.md b/_docs_v7/Container-Development.md index 54e65571..bb3b0a15 100644 --- a/_docs_v7/Container-Development.md +++ b/_docs_v7/Container-Development.md @@ -45,7 +45,7 @@ Please note that some of the examples refer to features that are only available A container can be started using the `run` command and the name, e.g. ``` -docker run su2code/su2/build-su2 +docker run su2code/build-su2 ``` You should see the following message, which means that everything works as intended: ``` @@ -64,7 +64,7 @@ The containers we provide all feature entrypoint scripts, i.e. a script that is A typical call where the current directory on the host is mounted and used as working directory would look like this: ``` -docker run -ti --rm -v $PWD:/workdir/ -w /workdir --entrypoint bash su2code/su2/build-su2 +docker run -ti --rm -v $PWD:/workdir/ -w /workdir --entrypoint bash su2code/build-su2 ``` Here, we also override the entrypoint in order to execute a bash shell. Note that all changes you make will be lost after you exit the container (except from changes in the working directory). Once in the bash you can simply use an existing or new clone of the repository to compile SU2 [the usual way](/docs_v7/Build-SU2-Linux-MacOS/), run a regression test script, or execute a specific regression test. @@ -93,7 +93,7 @@ Instead of checking out a fresh copy of the source code, it is also possible to ``` docker run -ti --rm -v ~/Documents/SU2:/workdir/src/SU2 \ -v ~/Documents/SU2/bin:/workdir/install/ -w /workdir \ - su2code/su2/build-su2 -f "-Denable-pywrapper=true" + su2code/build-su2 -f "-Denable-pywrapper=true" ``` The binaries can then be found at `~/Documents/SU2/bin`. @@ -110,7 +110,7 @@ The compiled binaries used for the tests must be mounted at `/install/bin`. The following command will clone the master branches of all required repositories and run the `parallel_regression.py` script: ``` docker run -ti --rm -v ~/Documents/SU2/bin:/workdir/install/bin \ - -w /workdir su2code/su2/test-su2 -t master -b master -c master -s parallel_regression.py + -w /workdir su2code/test-su2 -t master -b master -c master -s parallel_regression.py ``` Similar to the compilation script, you can use already existing clones of the repositories by mounting them at `/src/Tutorials`, `/src/SU2`, `/src/TestData` and omitting the `-t`, `-b` or `-c` option, respectively. @@ -119,11 +119,11 @@ The following example will compile SU2 using the `build-su2` container and then ``` docker run -ti --rm -v $PWD:/workdir/ -w /workdir \ - su2code/su2/build-su2 -f "-Denable-pywrapper=true" -b develop + su2code/build-su2 -f "-Denable-pywrapper=true" -b develop docker run -ti --rm -v $PWD/install/bin:/workdir/install/bin -w /workdir \ -v $PWD/src/SU2_develop:/workdir/src/SU2 \ - su2code/su2/test-su2 -t develop -c develop -s parallel_regression.py + su2code/test-su2 -t develop -c develop -s parallel_regression.py ``` ### Running thread sanitizer tests ### diff --git a/_docs_v7/Execution.md b/_docs_v7/Execution.md index e0ffc443..109a9519 100644 --- a/_docs_v7/Execution.md +++ b/_docs_v7/Execution.md @@ -15,7 +15,7 @@ Once downloaded and installed, and now that you know the basics for setting up y - [Discrete Adjoint Gradient Calculation (discrete_adjoint.py)](#discrete-adjoint-gradient-calculation-discreteadjointpy) - [Finite Difference Gradient Calculation (finite_differences.py)](#finite-difference-gradient-calculation-finitedifferencespy) - [Shape Optimization Script (shape_optimization.py)](#shape-optimization-script-shapeoptimizationpy) - + - [Python wrapper scripts](#python-wrapper-scripts) --- ## C++ Modules @@ -109,3 +109,30 @@ Options: * `-n PARTITIONS, --partitions=PARTITIONS` number of PARTITIONS * `-g GRADIENT, --gradient=GRADIENT` Method for computing the GRADIENT (ADJOINT, DISCRETE_ADJOINT, FINDIFF, NONE) * `-q QUIET, --quiet=QUIET` True/False Quiet all SU2 output (optimizer output only) + +### Python wrapper scripts + +It is possible to call SU2 from python by importing it as a module. The first step is to compile SU2 with python wrapper support. For instance if your SU2 repository is in your home directory at *~/SU2*: + +Usage: `$ ./meson.py build -Denable-pywrapper=true --prefix=~/SU2` + +The python module will then be available in the installation folder *~/SU2/bin*. To make the SU2 python wrapper available from everywhere in the system, add the installation path to *PYTHONPATH*: + +Usage: `export PYTHONPATH=~/SU2/bin:$PYTHONPATH` + +You should now be able to call SU2 from a python file. A quick way to test this is by using the following command: + +Usage: `python -c "import pysu2; print('hello world') "` + +If you see the message *hello world* without any error messages, you can now try to run the pywrapper examples in the */Testcases/py_wrapper* subdirectory. +For instance the unsteady flat plate with conjugate heat transfer. Note that the configuration files are inside the SU2 repository and the meshes for the testcases are inside the Testcases repository. We recommend to copy .cfg files to the Testcases repository and run from there. +``` +cd ~/Testcases/py_wrapper/flatplate_unsteady_CHT +cp ~/SU2/Testcases/py_wrapper/flatplate_unsteady_CHT/unsteady_CHT_FlatPlate_Conf.cfg . +python launch_unsteady_CHT_FlatPlate.py -f unsteady_CHT_FlatPlate_Conf.cfg +``` + +Options: +* `-h, --help` show this help message and exit +* `-f FILE, --file=FILE` read config from FILE +* `--parallel` Specify if we need to initialize MPI diff --git a/_includes/su2gui_nav.html b/_includes/su2gui_nav.html new file mode 100644 index 00000000..f2d70c56 --- /dev/null +++ b/_includes/su2gui_nav.html @@ -0,0 +1,22 @@ +
+{% for section in site.data.su2gui %} +
+
+

+ +

+
+
+
    + {% for item in section.su2gui %} + {% assign item_url = item | prepend:"/su2gui/" | append:"/" %} + {% assign p = site.su2gui | where:"url", item_url | first %} + {{ p.title }} + {% endfor %} +
+
+
+{% endfor %} +
diff --git a/_includes/su2gui_section_nav.html b/_includes/su2gui_section_nav.html new file mode 100644 index 00000000..a57f63f6 --- /dev/null +++ b/_includes/su2gui_section_nav.html @@ -0,0 +1,52 @@ +{% comment %} +Map grabs the doc sections, giving us an array of arrays. Join, flattens all +the items to a comma delimited string. Split turns it into an array again. +{% endcomment %} +{% assign su2gui = site.data.su2gui | map: 'su2gui' | join: ',' | split: ',' %} + +{% comment %} +Because this is built for every page, lets find where we are in the ordered +document list by comparing url strings. Then if there's something previous or +next, lets build a link to it. +{% endcomment %} + +{% for document in su2gui %} + {% assign document_url = document | prepend:"/su2gui/" | append:"/" %} + {% if document_url == page.url %} +
    + {% if forloop.first %} + + {% else %} + {% assign previous = forloop.index0 | minus: 1 %} + {% assign previous_page = su2gui[previous] | prepend:"/su2gui/" | append:"/" %} + + {% endif %} + + {% if forloop.last %} + + {% else %} + {% assign next = forloop.index0 | plus: 1 %} + {% assign next_page = su2gui[next] | prepend:"/su2gui/" | append:"/" %} + + {% endif %} + +
    + {% break %} + {% endif %} +{% endfor %} diff --git a/_includes/topnav.html b/_includes/topnav.html index b8173023..747df544 100644 --- a/_includes/topnav.html +++ b/_includes/topnav.html @@ -18,13 +18,14 @@
  • Docs
  • Tutorials
  • V&V
    • -
  • Forum
    • +
  • User Forum
    • +
  • Dev Team Slack
  • Develop
    • +
  • GUI
    • -
    • diff --git a/_layouts/su2gui.html b/_layouts/su2gui.html new file mode 100644 index 00000000..045e4848 --- /dev/null +++ b/_layouts/su2gui.html @@ -0,0 +1,55 @@ +--- +layout: default +--- + +
    +
    +
    + {% include su2gui_nav.html %} +
    + +
    +

    {{ page.title }}

    +
    {{ content }}
    +
    + {% unless true %} + + + + +
    +
    + {% endunless %} +

    +
    + + Improve this page + +

    + {% include su2gui_section_nav.html %} +
    + +
    +
    + + + diff --git a/_su2gui/Build-From-Source.md b/_su2gui/Build-From-Source.md new file mode 100644 index 00000000..40ae023b --- /dev/null +++ b/_su2gui/Build-From-Source.md @@ -0,0 +1,20 @@ +--- +title: Build From Source +permalink: /su2gui/Build-From-Source/ +--- + +This section guides you through using the source code to run SU2GUI on your device, enabling custom changes and optimizations. + +### Minimal Requirements + +- Python 3 +- SU2 Software +- Python Libraries listed in [requirements.txt](Link) + +### Installation and Setup + +Clone the source code from our [GitHub repository](Link). Navigate to the root folder and run `su2gui.py`. You can also pass additional options or create your custom terminal arguments. + +### Command to Start the Server + + usage: python su2gui.py [-h] [-p PORT] [-c CASE] [-m MESH] [--config CONFIG] [--restart RESTART] diff --git a/_su2gui/Configurations.md b/_su2gui/Configurations.md new file mode 100644 index 00000000..d260dc90 --- /dev/null +++ b/_su2gui/Configurations.md @@ -0,0 +1,48 @@ +--- +title: Configurations +permalink: /su2gui/configurations/ +--- + +This section explains how to use the configuration file and Config Tab in SU2GUI. For an overview of what a configuration file is, please refer to the [configuration file](../../docs_v7/Configuration-File/) page. + +## Loading a Configuration File +SU2GUI allows users to load a configuration file through both the GUI and the terminal. Loading the file is optional, as SU2GUI will create one if the user does not provide it. Before doing so, it is necessary for the user to initialize a Case. It is recommended to load the mesh file before the configuration file to set boundary condition properties and ensure proper functionality. + +**Steps to load configuration file:** + + 1. Start a new case and load mesh file. Follow these guides for detailed steps on [starting a new case](../Manage-Cases/#starting-a-new-case) and [loading a mesh file](../Mesh-File). + + + 2. Click on the "Load Config File" option. ![](../../su2gui_files/User_guide/Configuration/button-config-file.png) + + + 3. In the pop-up window, choose the desired configuration file. ![](../../su2gui_files/User_guide/Configuration/choose-config-file.png) + + + 4. The configuration file should now be loaded, and the properties in the GUI should be updated accordingly. ![](../../su2gui_files/User_guide/Configuration/loaded-config-file.png) + + + +For instructions on loading a configuration file through the terminal, refer to the guide on [ Terminal Initialization](./../Terminal-Initialization). + +## Config Tab + +The Config Tab allows users to analyze and modify the current state of the Configuration File. It presents the data in JSON format, which is then converted into a configuration file for SU2 when the solver is initiated. + +![Config Tab](../../su2gui_files/User_guide/Configuration/config-tab.png) + +### Adding New Properties + +User can add/modify Properties in configuration file using this. Place the Key in key textbox and Value in Value textbox. By default, Key is capitalised and preceding and trailing spaces are removed from the Key. Ways to add Value for property are given below: + +- **Adding Float/Int**: The system attempts to convert all input into a float. If the conversion fails, it proceeds with other data types. + +- **Adding Boolean**: The system recognizes "YES," "NO," "TRUE," and "FALSE" in any case (uppercase or lowercase) and stores them as boolean values. + +- **Adding List**: When a list is added, it creates a list of elements and checks if each element is a digit. Below are examples of correct and incorrect list formats: + + + + | **Correct List** | (outlet1, 101325, outlet2, 101325) | [outlet1, 101325, outlet2, 101325] | outlet1, 101325, outlet2, 101325 | outlet1 101325 outlet2 101325 | + |-------------------|------------------------------------|------------------------------------|---------------------------------|--------------------------------| + | **Incorrect List** | (outlet1, 101325, outlet2, 101325 | outlet1, 101325, outlet2, 101325} | outlet1, 101325 outlet2 101325 | outlet1101325 outlet2101325 | \ No newline at end of file diff --git a/_su2gui/Initialization.md b/_su2gui/Initialization.md new file mode 100644 index 00000000..c689d10d --- /dev/null +++ b/_su2gui/Initialization.md @@ -0,0 +1,78 @@ +--- +title: Initialization + +permalink: /su2gui/Initialization/ +--- + +Initialization is the process of setting up the initial conditions and parameters required to start a simulation. Proper initialization is crucial as it significantly influences the convergence and accuracy of the simulation. By specifying initial values or states, you provide a starting point for the solver, which helps in stabilizing the simulation and achieving reliable results more efficiently. + +SU2GUI supports three methods for initializing a problem, which are available under the Initialization section of the menu: + +- [**Uniform Initialization**](#uniform-initialization) +- [**Initialization using Restart File**](#initialization-using-restart-file) +- [**Patch Initialization**](#patch-initialization) + +### Opening the Initialization Options + +1. Start a new case and load the mesh file. Follow these guides for detailed steps on [starting a new case](../Manage-Cases/#starting-a-new-case) and [loading a mesh file](../Mesh-File). + +2. Navigate to the Initialization section from the left menu: + ![](../../su2gui_files/User_guide/initialization/initialize-options.png) + +Follow the steps below according to the type of initialization needed. + +--- + +## Uniform Initialization + +**Description**: This method involves assigning a single set of initial values (like pressure, velocity, temperature, etc.) uniformly across the entire computational domain. + +**Use Case**: Uniform initialization is commonly used when you have little prior knowledge about the flow field or when you want to start with a simple baseline. + +**Steps for Uniform Initialization** + +1. After opening the Initialization options, select **Uniform Initialization** from the drop-down menu. + +2. Enter the required properties. The properties will vary depending on the selected Solver and Configurations. + +3. Press the **Initialize** button. The problem will be initialized, and the visualization window will update accordingly.![](../../su2gui_files/User_guide/initialization/loaded-uniform-initialize.png) + +--- + +## Initialization using Restart File + +**Description**: This method uses a previously saved simulation state from a Restart file to initialize the current simulation. + +**Use Case**: This is ideal for continuing simulations from where they left off or for testing variations without starting from scratch, which can save time and resources. + +SU2GUI supports both `.dat` and `.csv` formats for restart files. + +**Steps for Restart Initialization** + +1. After opening the Initialization options, select **Restart File Initialization** from the drop-down menu. + +2. Click on the **Load Restart File** option. ![](../../su2gui_files/User_guide/Initialization/button-restart-file.png) + +3. In the pop-up window, choose the desired restart file. ![](../../su2gui_files/User_guide/initialization/choose-restart-file.png) + +4. The Restart file will be loaded, and the visualization window will update accordingly. ![](../../su2gui_files/User_guide/initialization/loaded-restart-file.png) + +For instructions on loading a restart file through the terminal, refer to the guide on [ Terminal Initialization](./../Terminal-Initialization). + +--- + +## Patch Initialization + +**Description**: Patch initialization allows you to define different initial conditions for specific regions (or patches) within the computational domain. + +**Use Case**: This method is useful for simulations with complex geometries or varying conditions, enabling more precise control over the initial state of the simulation. + +SU2GUI currently supports three types of patch initialization: Plane, Sphere, and Box. + +**Steps for Patch Initialization** + +1. After opening the Initialization options, select **Patch Initialization** from the drop-down menu. + +2. Select type of Patch and enter the required properties for both zones. The properties will change according to the selected Solver and Configurations. + +3. Press the **Initialize** button. The problem will be initialized, and the visualization window will update accordingly. ![](../../su2gui_files/User_guide/initialization/loaded-patch-initialize.png) diff --git a/_su2gui/Installation.md b/_su2gui/Installation.md new file mode 100644 index 00000000..48046891 --- /dev/null +++ b/_su2gui/Installation.md @@ -0,0 +1,26 @@ +--- +title: Installation +permalink: /su2gui/Installation/ +--- + +SU2GUI is designed to be easy to install and offers an intuitive user experience. However, it requires the SU2 software suite to be installed on your system. For instructions on installing SU2, please refer to the [SU2 Installation Guide](../../docs_v7/Installation/). + +### Prerequisites + +- Python 3.10 or higher +- SU2 installed on your system. Follow the installation instructions [here](../../docs_v7/Installation/). + +## Installation + +You can install SU2GUI via pip: + + pip install su2gui + + +### Usage +To launch the GUI, run the following command in your terminal: + + + SU2_GUI + +For a quick introduction to using SU2GUI, visit the [Quick start](./../Quick-start) page. For additional terminal options, refer to the [Terminal Initialization](./../Terminal-Initialization) page. \ No newline at end of file diff --git a/_su2gui/Introduction.md b/_su2gui/Introduction.md new file mode 100644 index 00000000..24e73b71 --- /dev/null +++ b/_su2gui/Introduction.md @@ -0,0 +1,39 @@ +--- +title: Welcome to SU2GUI +permalink: /su2gui/Introduction/ +--- + +**Welcome to SU2GUI!** + +SU2GUI is a Python-based Graphical User Interface (GUI) designed to simplify the setup, execution, and analysis of simulations using the SU2 software suite. It offers an intuitive interface with real-time visualization and comprehensive case management capabilities. It utilizes several Python libraries such as Pandas, VTK, JSON, Trame, and Vuetify to deliver its full functionality. These libraries handle data processing, visualization, and user interface components, making SU2GUI both powerful and versatile. + +## Why Use SU2GUI? + +- **User-Friendly Interface:** Navigate complex simulations with ease. +- **Real-Time Visualization:** See results as they happen, enabling quick adjustments. +- **Comprehensive Case Management:** Organize, load, and manage your simulations effortlessly. + +## Explore the SU2GUI Workflow + +Here’s a snapshot of how SU2GUI simplifies your work: + +![overview_su2gui](../../su2gui_files/User_guide/workflow.png) + +### 1. Launch SU2GUI +Get started by running the `SU2_GUI` command in your terminal. This opens up the graphical interface where operations are conducted. + +### 2. Start Your Case +You can either create a new case or load your previous case. Upload the necessary files—including mesh, configuration, and more—directly through the GUI if needed and make the required changes. SU2GUI keeps everything organized so you can focus on your simulation. + +### 3. Run Your Simulation +With everything loaded, you can set up and run your simulation directly from the GUI. SU2GUI provides a user-friendly environment to configure parameters, initialize conditions, and start the solver. + +### 4. Visualize Results +As the simulation runs, you can visualize and analyze the results in real-time using the integrated visualization tools within SU2GUI. This allows for immediate feedback and adjustments to the simulation if needed. + +### 5. Manage Your Cases +Easily manage your simulation projects with SU2GUI’s case management features. Download, delete, or switch between cases with just a few clicks. + +## Ready to Get Started? + +Dive deeper with our [QuickStart guide](./../Quick-Start) and get started with SU2GUI. \ No newline at end of file diff --git a/_su2gui/Logs-Tab-and-Errors.md b/_su2gui/Logs-Tab-and-Errors.md new file mode 100644 index 00000000..ed92e4f2 --- /dev/null +++ b/_su2gui/Logs-Tab-and-Errors.md @@ -0,0 +1,38 @@ +--- +title: Log Tab and Errors +permalink: /su2gui/Logs-Errors/ +--- + +The SU2 and SU2GUI logs provide essential information about the execution and performance of both the SU2 software and SU2GUI. These logs can be accessed and analyzed real-time on SU2GUI under LOGS Tab. + + +## SU2 Logs + +![SU2 Log Tab](../../su2gui_files/User_guide/logs/su2-logs.png) + +The SU2 logs contain detailed information about the solver's execution, including convergence history, residual values, and solution progress. These logs are invaluable for identifying convergence issues, detecting numerical instabilities, and gaining insights into the overall simulation process. + +Each SU2 log file is stored within the corresponding case folder and is unique to that specific case. To access the SU2 log for a particular case, you can download the case folder. Reviewing these log files allows for a detailed analysis of the solver's performance and the progress of individual simulations. + +--- +## SU2GUI Logs + +![SU2GUI Log Tab](../../su2gui_files/User_guide/logs/su2gui-logs.png) + +The SU2GUI logs capture interactions and events within the graphical user interface. These logs are useful for understanding user actions, identifying errors or warnings, and tracking the workflow followed during a simulation setup. + +Unlike the SU2 logs, the SU2GUI log file is updated and cleared each time SU2GUI is started. This ensures that the log file only contains information from the current session, preventing the accumulation of data from previous sessions. + +--- + +## Error/Warn Message + +![Error message](../../su2gui_files/User_guide/logs/error-message.png) + +In addition to capturing interactions and events within the graphical user interface, SU2GUI also displays any Error and Warning messages received in the log files as pop-up dialog box. This feature helps users quickly identify and address any issues or potential problems during the simulation setup or execution. + +By presenting these messages in a pop-up format, SU2GUI ensures that users are immediately alerted to any errors or warnings, allowing for prompt action to be taken. This real-time feedback enhances the user experience and facilitates efficient troubleshooting. + +### Importance of Log Analysis + +Analyzing the SU2 and SU2GUI logs can provide valuable insights into the simulation process, help diagnose issues, and optimize the performance of your simulations. It is recommended to review these logs whenever you are troubleshooting or optimizing your SU2 simulations to ensure a smooth and efficient workflow. diff --git a/_su2gui/Manage-Cases.md b/_su2gui/Manage-Cases.md new file mode 100644 index 00000000..ba4173d7 --- /dev/null +++ b/_su2gui/Manage-Cases.md @@ -0,0 +1,52 @@ +--- +title: Manage Cases +permalink: /su2gui/Manage-Cases/ +--- + +Loading a case is essential to start working with SU2GUI, as it helps organize all files related to the case. The ability to download, delete, and load previous test cases gives users greater control over their case library. + +### Steps for Starting a New Case + +1. Click the **Cases** button in the top menu to open the **Manage Cases** dialog box. + +2. In the dialog box, click the **New Case** button to open the **Start a New Case** dialog box. + +3. Enter the case name and check the box if you want to remove all previous cases. + +4. Click **Initialize** to start the new case. + +--- + +### Steps for Downloading a Case(s) + +1. Click the **Cases** button in the top menu to open the **Manage Cases** dialog box. + +2. From the drop-down menu, select the case you want to download, or check the box to select all cases (including the current case). + +3. Click the **Download** button to download the selected case(s). + +--- + +### Steps for Deleting a Case(s) + +1. Click the **Cases** button in the top menu to open the **Manage Cases** dialog box. + +2. From the drop-down menu, select the case you want to delete, or check the box to select all cases (excluding the current case). + +3. Click the **Delete** button to remove the selected case(s). + +--- + +### Steps for Loading an Existing Case(s) + +1. Click the **Cases** button in the top menu to open the **Manage Cases** dialog box. + +2. From the drop-down menu, select the case you want to load. + +3. Click the **Load** button to load the selected case. + +--- + +## Loading a Case from the Terminal + +When starting SU2GUI from the terminal, users can specify a case name. If the case already exists, SU2GUI will load it; if not, it will start a new case. For instructions on loading a case through the terminal, refer to the guide on [Terminal Initialization](./../Terminal-Initialization). \ No newline at end of file diff --git a/_su2gui/Mesh.md b/_su2gui/Mesh.md new file mode 100644 index 00000000..373256d3 --- /dev/null +++ b/_su2gui/Mesh.md @@ -0,0 +1,28 @@ +--- +title: Mesh File +permalink: /su2gui/Mesh-File/ +--- + + +This section explains how to use the mesh file in SU2GUI. Currently, SU2GUI only supports mesh files in .su2 format. For an overview of what a mesh file is, please refer to the [mesh file](../../docs_v7/Mesh-File/) page. + +## Loading a Mesh File + +SU2GUI offers the option to load a mesh file through both the GUI and the terminal. Loading the `.su2` mesh file is mandatory. Before doing so, it is necessary for the user to initialize a Case. + +**Steps to load mesh file:** + + 1. Start a new case. Follow these guides for detailed steps on [starting a new case](./../Manage-Cases/#starting-a-new-case). + + + 2. Click on the "Load Mesh File" option. ![](../../su2gui_files/User_guide/Mesh/button-mesh-file.png) + + + 3. In the pop-up window, choose the desired mesh file. ![](../../su2gui_files/User_guide/Mesh/choose-mesh-file.png) + + + 4. The mesh file should now be loaded, and the properties in the GUI should be updated accordingly. ![](../../su2gui_files/User_guide/Mesh/loaded-mesh-file.png) + + + +For instructions on loading a mesh file through the terminal, refer to the guide on [ Terminal Initialization](./../Terminal-Initialization). \ No newline at end of file diff --git a/_su2gui/Quick-Start.md b/_su2gui/Quick-Start.md new file mode 100644 index 00000000..9361526b --- /dev/null +++ b/_su2gui/Quick-Start.md @@ -0,0 +1,80 @@ +--- +title: Quick Start +permalink: /su2gui/Quick-Start/ +--- + +Welcome to the Quick Start Tutorial for the SU2GUI. This tutorial introduces key features of SU2GUI, taking only a few minutes to complete. If you haven’t done so already, please visit the [SU2](../../docs_v7/Installation/) and [SU2_GUI](./../Installation) download pages to obtain the latest stable releases and installation details. This tutorial mirrors the [SU2 Quick Start](../../docs_v7/Quick-Start/) guide and requires both the SU2_CFD and SU2_GUI tools. + +This guide will help you: + +- [Set up SU2GUI](#setup-su2gui) +- [Start a new case](#start-a-new-case) +- [Load mesh file](#load-mesh-file) +- [Load Configurations](#load-configurations) +- [Run simulation](#run-simulation) +- [Download case](#download-case) +- [Analyze results](#analyze-results) + +### Setup SU2GUI + +If you haven’t installed SU2_GUI, run the following command: + + pip install su2gui + +To start the GUI, enter the following in your terminal: + + SU2_GUI + +### Start a New Case + +1. In the pop-up window, enter a new case name (e.g., `inv_naca0012`). +2. Press the Create button. + +![](../../su2gui_files/Quick_Start/new-case.png) + +### Load Mesh File + +We will load the mesh file from [SU2/mesh_NACA0012_inv.su2](https://github.com/su2code/SU2/blob/master/QuickStart/mesh_NACA0012_inv.su2): + +1. Click on "Load Mesh File" from the top pane. +2. In the pop-up window, select the mesh file, and it will be loaded. + +![](../../su2gui_files/User_guide/Mesh/button-mesh-file.png) + +### Load Configurations + +Next, load the configuration file from [SU2/QuickStart/inv_NACA0012.cfg](https://github.com/su2code/SU2/blob/master/QuickStart/inv_NACA0012.cfg): + +1. Click on "Load Config File" from the top pane. +2. In the pop-up window, choose the configuration file. You can also make other configuration changes through the GUI. + +![](../../su2gui_files/Quick_Start/load-config.png) + +### Run Simulation + +1. Navigate to the Solver node from the Menu. +2. Set the desired number of iterations (default may be 250). +3. Press the Start Solver button to begin the simulation. + +![](../../su2gui_files/Quick_Start/start-solver.png) + +### Download Case + +1. From the top pane, click on the Case button. +2. Select your current case (`inv_naca0012`) from the Cases dropdown menu. +3. Click the Download button to download the case. + +![](../../su2gui_files/Quick_Start/download-case.png) + +### Analyze Results + +1. In the top pane, select "Mach" from the Color By dropdown menu. +2. Turn off the mesh preview using the indicated button. +3. Zoom in on the mesh for a better view and analyze the results. + +![](../../su2gui_files/Quick_Start/analyze-results.png) + +## Next Steps + +- Further analyze the results in Paraview. +- Explore the [SU2 QuickStart](../../docs_v7/Quick-Start/) guide for more details. diff --git a/_su2gui/Result-Analysis.md b/_su2gui/Result-Analysis.md new file mode 100644 index 00000000..1e516cbf --- /dev/null +++ b/_su2gui/Result-Analysis.md @@ -0,0 +1,43 @@ +--- +title: Result Analysis +permalink: /su2gui/Result-Analysis/ +--- + +## Analyzing SU2 Output Files + +When working with SU2, several key output files are generated that are crucial for analyzing the performance and results of your simulations. These files include `History.csv`, `Restart.csv`, and various files representing the current state of the solver. Understanding and analyzing these files is essential for extracting meaningful insights and further refining your simulations. + +### History Tab + +The `History.csv` file logs the convergence history of your simulation. It typically includes data such as iteration number, residuals, lift and drag coefficients, and other relevant metrics. By analyzing this file, you can: + +- **Monitor Convergence**: Ensure your simulation is converging by tracking how residuals decrease over iterations. +- **Evaluate Performance**: Assess key metrics like lift and drag coefficients to determine the aerodynamic characteristics of your model. +- **Identify Issues**: Detect irregularities that may indicate problems with your simulation setup. + +SU2GUI provides a convenient "History Tab" feature that allows you to visualize the `History.csv` file in real time, enabling you to monitor the convergence and track key metrics as they evolve. You can also select specific parameters to plot, enabling more focused analysis of key metrics. + + +![History Tab](../../su2gui_files/User_guide/result-analysis/history-tab.png) +--- +### Geometry Tab + +The `Restart.csv` file stores the simulation state at a specific point in time. It is essential for: + +- **Real-Time Monitoring**: Track the solver's state in real time to monitor progress and make necessary adjustments. +- **Resuming Simulations**: Continue an interrupted simulation from the last saved state. +- **Debugging**: Examine the current state to identify and resolve issues if the simulation encounters problems. + +SU2GUI offers a "Geometry Tab" feature that lets you visualize the `Restart.csv` file in real time, facilitating real-time monitoring. + +![Geometry Tab](../../su2gui_files/User_guide/result-analysis/geometry-tab.png) +--- +### Output Files for Further Analysis + +SU2 generates various output files, such as: + +- **Flow Field Data**: Velocity, pressure, and temperature distributions. +- **Surface Data**: Pressure and skin friction coefficients. +- **Visualization Files**: Files compatible with tools like ParaView. + +SU2GUI allows you to download all output files from a case. For instructions on case management, refer to the [case installation procedure](../Manage-Cases/). By thoroughly analyzing these files, you can gain insights, validate models, and make informed decisions for future simulations. diff --git a/_su2gui/Supported-Functionalities.md b/_su2gui/Supported-Functionalities.md new file mode 100644 index 00000000..969ef4dc --- /dev/null +++ b/_su2gui/Supported-Functionalities.md @@ -0,0 +1,45 @@ +--- +title: Supported Functionalities +permalink: /su2gui/Supported-Functionalities/ +--- + + +In this section, we explore the various supported functionalities of the SU2 GUI. While the SU2 GUI currently doesn't support all the features of the SU2 suite, you can still make adjustments using traditional methods. + +The supported properties are organized according to the nodes in the Side Menu: + +### Physics + +This node supports selecting Solver, Turbulence Model, Sub-Model, Energy Equation, and Wall Function. + +For more details on models in SU2, refer to this [page](../../docs_v7/Physical-Definition/). + +### Materials + +This node supports selecting the type of fluid density, viscosity, heat capacity, and conductivity, and specifying the necessary properties. + +### Numeric + +This node supports selecting the type of Spatial Gradients, MUSCL Spatial Gradients, and CFL value. + +### Boundaries + +This node contains sub-nodes based on the user's mesh file. Each sub-node allows you to modify the properties of that boundary. + +Currently supported Boundary Markers include: + +`MARKER_ISOTHERMAL`, `MARKER_HEATFLUX`, `MARKER_HEATTRANSFER`, `MARKER_EULER`, `MARKER_WALL_FUNCTIONS`, `MARKER_OUTLET`, `INC_OUTLET_TYPE`, `MARKER_SYM`, `MARKER_FAR`, `MARKER_INLET`, `INC_INLET_TYPE`, `INLET_TYPE`, `MARKER_SUPERSONIC_INLET`, `MARKER_SUPERSONIC_OUTLET`. + +### Initialization + +This node provides options for initializing the simulation. Uniform initialization requires constant values, Patch Initialization requires constant values for two zones, and Restart File Initialization requires a restart file in .dat or .csv format. + +For more details on initialization, refer to this [page](../Initialization/). + +### FileIO + +This node supports managing file input/output. It includes options to rename Restart, Volume Output, and History files, and select their writing frequency for the current case. Additionally, there are options to overwrite Restart and Volume files. + +### Solver + +This node allows you to adjust the residual convergence value and iteration count, with support currently limited to ITER. Using the solver button, you can start SU2_CFD, and visualization will begin as the restart file is created. Please note that result visualization is currently supported only for 2D simulations, not 3D. \ No newline at end of file diff --git a/_su2gui/Terminal-Initialization.md b/_su2gui/Terminal-Initialization.md new file mode 100644 index 00000000..40b47a87 --- /dev/null +++ b/_su2gui/Terminal-Initialization.md @@ -0,0 +1,46 @@ +--- +title: Terminal Initialization +permalink: /su2gui/Terminal-Initialization/ +--- + +SU2GUI can be initialized directly from the terminal, allowing users to provide the Case Name and other relevant files during initialization. + +### Usage + +The basic syntax for initializing SU2GUI from the terminal is as follows: + + usage: SU2_GUI [-h] [-p PORT] [-c CASE] [-m MESH] [--config CONFIG] [--restart RESTART] + + +### Options + +- `-h, --help` + Displays the help message and exits. + +- `-p , --port PORT` + Specifies the port to be used. The default port is `8080`. + +- `-c , --case CASE` + Defines the name of the case to start with. + +- `-m , --mesh MESH` + Specifies the path to the SU2 mesh file in `.su2` format. + +- `--config CONFIG` + Specifies the path to the configuration file in `.cfg` format. + +- `--restart RESTART` + Specifies the path to the restart file in `.csv` or `.dat` format. + +### Important Notes + +- **Case Name Requirement**: The Case Name must be provided for the initialization of the MESH, CONFIG, or RESTART file. Without specifying a Case Name, these files cannot be initialized. + +- All the options mentioned above are completely optional. Users can choose to provide any combination of these options based on their requirements. + +### Example Command + +To initialize SU2GUI with a specific case name, port, mesh file, configuration file, and restart file, use the following command: + + + SU2_GUI -p 5000 -c case_name -m path_to_mesh_file --config path_to_config_file --restart path_to_restart_file diff --git a/_tutorials/compressible_flow/UQ_NACA0012/UQ_NACA0012.md b/_tutorials/compressible_flow/UQ_NACA0012/UQ_NACA0012.md index ffe9095e..cd0ceb05 100644 --- a/_tutorials/compressible_flow/UQ_NACA0012/UQ_NACA0012.md +++ b/_tutorials/compressible_flow/UQ_NACA0012/UQ_NACA0012.md @@ -73,8 +73,8 @@ If there is a need to perform the perturbations individually (for example to run ``` % ------------------- UNCERTAINTY QUANTIFICATION DEFINITION -------------------% % -% Using uncertainty quantification module (YES, NO). Only available with SST -USING_UQ= YES +% Using uncertainty quantification module. Available as an option for the SST turbulence model. +SST_OPTIONS= UQ % % Eigenvalue perturbation definition (1, 2, or 3) UQ_COMPONENT= 1 diff --git a/_tutorials/design_features/Species_Transport/Species_Transport.md b/_tutorials/design_features/Species_Transport/Species_Transport.md index 4dd732aa..10706f7d 100644 --- a/_tutorials/design_features/Species_Transport/Species_Transport.md +++ b/_tutorials/design_features/Species_Transport/Species_Transport.md @@ -179,7 +179,7 @@ Here the user can also fix certain Design variables by simply not using them in ``` % ----------------------- DESIGN VARIABLE PARAMETERS --------------------------% % -DV_KIND= FFD_CONTROL_POINT, FFD_CONTROL_POINT, FFD_CONTROL_POINT, FFD_CONTROL_POINT, FFD_CONTROL_POINT, FFD_CONTROL_POINT, FFD_CONTROL_POINT, FFD_CONTROL_POINT, FFD_CONTROL_POINT, FFD_CONTROL_POINT +DV_KIND= FFD_CONTROL_POINT_2D, FFD_CONTROL_POINT_2D, FFD_CONTROL_POINT_2D, FFD_CONTROL_POINT_2D, FFD_CONTROL_POINT_2D, FFD_CONTROL_POINT_2D, FFD_CONTROL_POINT_2D, FFD_CONTROL_POINT_2D, FFD_CONTROL_POINT_2D, FFD_CONTROL_POINT_2D % % Marker of the surface in which we are going apply the shape deformation % NOTE: for deformation the outlet should be a MARKER_SYM to hinder the mesh being ripped apart. @@ -188,9 +188,9 @@ DV_MARKER= ( wall ) % Parameters of the shape deformation % - FFD_SETTING ( 1.0 ) % - FFD_CONTROL_POINT ( FFD_BoxTag, i_Ind, j_Ind, k_Ind, x_Disp, y_Disp, z_Disp ) -DV_PARAM= (BOX, 2, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 3, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 4, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 5, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 6, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 2, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 3, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 4, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 5, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 6, 1, 0, 0.0, +DV_PARAM= (BOX, 2, 0, 0.0, 1.0); (BOX, 3, 0, 0.0, 1.0); (BOX, 4, 0, 0.0, 1.0); (BOX, 5, 0, 0.0, 1.0); (BOX, 6, 0, 0.0, 1.0); (BOX, 2, 1, 0.0, 1.0); (BOX, 3, 1, 0.0, 1.0); (BOX, 4, 1, 0.0, 1.0); (BOX, 5, 1, 0.0, 1.0); (BOX, 6, 1, 0.0, 1.0) % Excluded FFD points that are fixed to keep a nice geometry and mesh -%DV_PARAM= (BOX, 0, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 1, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 0, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 1, 1, 0, 0.0, 1.0, 0.0 ); +%DV_PARAM= (BOX, 0, 0, 0.0, 1.0); (BOX, 1, 0, 0.0, 1.0); (BOX, 0, 1, 0.0, 1.0); (BOX, 1, 1, 0.0, 1.0); % % Value of the shape deformation % first row: lower row y-direction @@ -312,4 +312,4 @@ Figure (4): Objective Function value and Gradient Norm over optimizer iterations Figure (5): Baseline and Optimized Mesh with the respective FFD-Boxes. ![Optimization Cycle](../../tutorials_files/design_features/Species_Transport/images/opt_cycle.gif) -Figure (6): Optimization series from baseline to final mesh with FFD-Boxes. \ No newline at end of file +Figure (6): Optimization series from baseline to final mesh with FFD-Boxes. diff --git a/_tutorials/incompressible_flow/Inc_Streamwise_Periodic/Inc_Streamwise_Periodic.md b/_tutorials/incompressible_flow/Inc_Streamwise_Periodic/Inc_Streamwise_Periodic.md index 209f97e0..801bb415 100644 --- a/_tutorials/incompressible_flow/Inc_Streamwise_Periodic/Inc_Streamwise_Periodic.md +++ b/_tutorials/incompressible_flow/Inc_Streamwise_Periodic/Inc_Streamwise_Periodic.md @@ -117,7 +117,7 @@ Additional `SCREEN_OUTPUT` for streamwise periodic flow is `STREAMWISE_MASSFLOW` In this tutorial, 2 configuration files are provided which differ in the streamwise periodic options. -[First](https://github.com/su2code/Tutorials/tree/master/incompressible_flow/Inc_Streamwise_Periodic/sp_pinArray_dp_hf_tp.cfg), one of the simplest setups with a user provided pressure drop over the domain is chosen. Temperature periodicity is activated. +[First](https://github.com/su2code/Tutorials/tree/master/incompressible_flow/Inc_Streamwise_Periodic/sp_pinArray_2d_dp_hf_tp.cfg), one of the simplest setups with a user provided pressure drop over the domain is chosen. Temperature periodicity is activated. ``` % --------------------- STREAMWISE PERIODICITY DEFINITION ---------------------% % @@ -127,7 +127,7 @@ STREAMWISE_PERIODIC_PRESSURE_DROP= 208.023676 STREAMWISE_PERIODIC_TEMPERATURE= YES % ``` -For the [second configuration](https://github.com/su2code/Tutorials/tree/master/incompressible_flow/Inc_Streamwise_Periodic/sp_pinArray_mf_hf.cfg) a massflow is prescribed. The initial pressure drop matches the final value but changes within the first iterations until the flow converges. Streamwise periodic temperature is deactivated so the outlet heatsink is used. In this case the 3 heatflux markers form a full circle which makes an exact computation of the introduced heatflux possible which can be then specified using the `STREAMWISE_PERIODIC_OUTLET_HEAT`. Note that an exact computation of this value is not always possible and also not necessary as the area-averaged inlet temperature must match `INC_TEMPERATURE_INIT` upon convergence which serves as an anchor for the temperature. +For the [second configuration](https://github.com/su2code/Tutorials/tree/master/incompressible_flow/Inc_Streamwise_Periodic/sp_pinArray_2d_mf_hf.cfg) a massflow is prescribed. The initial pressure drop matches the final value but changes within the first iterations until the flow converges. Streamwise periodic temperature is deactivated so the outlet heatsink is used. In this case the 3 heatflux markers form a full circle which makes an exact computation of the introduced heatflux possible which can be then specified using the `STREAMWISE_PERIODIC_OUTLET_HEAT`. Note that an exact computation of this value is not always possible and also not necessary as the area-averaged inlet temperature must match `INC_TEMPERATURE_INIT` upon convergence which serves as an anchor for the temperature. ``` % --------------------- STREAMWISE PERIODICITY DEFINITION ---------------------% % @@ -204,4 +204,4 @@ The **extension to CHT** cases is straight forward as the options in the fluid z **Temperature depended material properties** are only reasonable to be used with `STREAMWISE_PERIODIC_TEMPERATURE= NO` as the solution variable Temperature would be truly periodic and therefore non-physical. The recovered Temperature would need to be used instead which is not available in the code at the moment. -The **discrete adjoint** does not work with `KIND_STREAMWISE_PERIODIC= MASSFLOW` in the moment. All other features are working with the discrete adjoint solver. \ No newline at end of file +The **discrete adjoint** does not work with `KIND_STREAMWISE_PERIODIC= MASSFLOW` in the moment. All other features are working with the discrete adjoint solver. diff --git a/_tutorials/incompressible_flow/Inc_Turbulent_Bend/Inc_Turbulent_Bend.md b/_tutorials/incompressible_flow/Inc_Turbulent_Bend/Inc_Turbulent_Bend.md index 101bd8ed..a9c65419 100644 --- a/_tutorials/incompressible_flow/Inc_Turbulent_Bend/Inc_Turbulent_Bend.md +++ b/_tutorials/incompressible_flow/Inc_Turbulent_Bend/Inc_Turbulent_Bend.md @@ -29,6 +29,10 @@ In this tutorial we will simulate the turbulent flow in a 90 degree pipe bend. W The resources for this tutorial can be found in the [incompressible_flow/Inc_Turbulent_Bend_Wallfunctions](https://github.com/su2code/Tutorials/tree/master/incompressible_flow/Inc_Turbulent_Bend_Wallfunctions) directory in the [tutorial repository](https://github.com/su2code/Tutorials). You will need the configuration file ([sudo.cfg](https://github.com/su2code/Tutorials/tree/master/incompressible_flow/Inc_Turbulent_Bend_Wallfunctions/sudo.cfg)) and the mesh file ([sudo_coarse.su2](https://github.com/su2code/Tutorials/tree/master/incompressible_flow/Inc_Turbulent_Bend_Wallfunctions/sudo_coarse.su2)). Additionally, the Gmsh geometry is also provided so you can recreate the mesh yourself: [sudo_coarse.geo](https://github.com/su2code/Tutorials/tree/master/incompressible_flow/Inc_Turbulent_Bend_Wallfunctions/sudo_coarse.geo). +This test case was also presented at the 2022 SU2 conference: +- [2022 su2 conference](https://su2foundation.org/su2conference2022/) +- [doc:Turbulence modeling with wall functions](https://drive.google.com/file/d/16al4x0VIk9tDepSBjrJf0YTqaEu9QHDn/view) +- [youtube:Turbulence modeling with wall functions](https://drive.google.com/file/d/16al4x0VIk9tDepSBjrJf0YTqaEu9QHDn/view) ## Tutorial diff --git a/index.html b/index.html index e00c49fb..90a5f70e 100644 --- a/index.html +++ b/index.html @@ -38,9 +38,9 @@

    Powerful. Fast. Free.

    -

    4th Annual SU2 Conference

    -

    The 4th edition of the SU2 conference takes place in Varenna/Italy on the 23rd - 25th of October.

    -

    Registration and abstract submission are open now and the links to the respective platforms together with all up-to-date information can be found on the conference website.

    +

    5th Annual SU2 Conference

    +

    The 5th edition of the SU2 conference takes place in Varenna/Italy from 30th of September to 2nd of October.

    +

    Registration and abstract submission are open now and the links to the respective platforms together with all up-to-date information can be found on the conference website.

    diff --git a/su2gui_files/Quick_Start/analyze-results.png b/su2gui_files/Quick_Start/analyze-results.png new file mode 100644 index 00000000..8d9bbeb6 Binary files /dev/null and b/su2gui_files/Quick_Start/analyze-results.png differ diff --git a/su2gui_files/Quick_Start/download-case.png b/su2gui_files/Quick_Start/download-case.png new file mode 100644 index 00000000..9eb7d06e Binary files /dev/null and b/su2gui_files/Quick_Start/download-case.png differ diff --git a/su2gui_files/Quick_Start/load-config.png b/su2gui_files/Quick_Start/load-config.png new file mode 100644 index 00000000..7cc2d242 Binary files /dev/null and b/su2gui_files/Quick_Start/load-config.png differ diff --git a/su2gui_files/Quick_Start/new-case.png b/su2gui_files/Quick_Start/new-case.png new file mode 100644 index 00000000..ee1d01ea Binary files /dev/null and b/su2gui_files/Quick_Start/new-case.png differ diff --git a/su2gui_files/Quick_Start/start-solver.png b/su2gui_files/Quick_Start/start-solver.png new file mode 100644 index 00000000..234e1738 Binary files /dev/null and b/su2gui_files/Quick_Start/start-solver.png differ diff --git a/su2gui_files/User_guide/Configuration/button-config-file.png b/su2gui_files/User_guide/Configuration/button-config-file.png new file mode 100644 index 00000000..e11e6d6c Binary files /dev/null and b/su2gui_files/User_guide/Configuration/button-config-file.png differ diff --git a/su2gui_files/User_guide/Configuration/choose-config-file.png b/su2gui_files/User_guide/Configuration/choose-config-file.png new file mode 100644 index 00000000..87567e07 Binary files /dev/null and b/su2gui_files/User_guide/Configuration/choose-config-file.png differ diff --git a/su2gui_files/User_guide/Configuration/config-tab.png b/su2gui_files/User_guide/Configuration/config-tab.png new file mode 100644 index 00000000..c87a4838 Binary files /dev/null and b/su2gui_files/User_guide/Configuration/config-tab.png differ diff --git a/su2gui_files/User_guide/Configuration/loaded-config-file.png b/su2gui_files/User_guide/Configuration/loaded-config-file.png new file mode 100644 index 00000000..d2c4e4d7 Binary files /dev/null and b/su2gui_files/User_guide/Configuration/loaded-config-file.png differ diff --git a/su2gui_files/User_guide/Logs/error-message.png b/su2gui_files/User_guide/Logs/error-message.png new file mode 100644 index 00000000..b17e30f8 Binary files /dev/null and b/su2gui_files/User_guide/Logs/error-message.png differ diff --git a/su2gui_files/User_guide/Logs/su2-logs.png b/su2gui_files/User_guide/Logs/su2-logs.png new file mode 100644 index 00000000..62072124 Binary files /dev/null and b/su2gui_files/User_guide/Logs/su2-logs.png differ diff --git a/su2gui_files/User_guide/Logs/su2gui-logs.png b/su2gui_files/User_guide/Logs/su2gui-logs.png new file mode 100644 index 00000000..99a0b0fe Binary files /dev/null and b/su2gui_files/User_guide/Logs/su2gui-logs.png differ diff --git a/su2gui_files/User_guide/initialization/button-restart-file.png b/su2gui_files/User_guide/initialization/button-restart-file.png new file mode 100644 index 00000000..67446294 Binary files /dev/null and b/su2gui_files/User_guide/initialization/button-restart-file.png differ diff --git a/su2gui_files/User_guide/initialization/choose-restart-file.png b/su2gui_files/User_guide/initialization/choose-restart-file.png new file mode 100644 index 00000000..f027e0f9 Binary files /dev/null and b/su2gui_files/User_guide/initialization/choose-restart-file.png differ diff --git a/su2gui_files/User_guide/initialization/initialize-options.png b/su2gui_files/User_guide/initialization/initialize-options.png new file mode 100644 index 00000000..d94cc453 Binary files /dev/null and b/su2gui_files/User_guide/initialization/initialize-options.png differ diff --git a/su2gui_files/User_guide/initialization/loaded-patch-initialize.png b/su2gui_files/User_guide/initialization/loaded-patch-initialize.png new file mode 100644 index 00000000..3e4f819e Binary files /dev/null and b/su2gui_files/User_guide/initialization/loaded-patch-initialize.png differ diff --git a/su2gui_files/User_guide/initialization/loaded-restart-file.png b/su2gui_files/User_guide/initialization/loaded-restart-file.png new file mode 100644 index 00000000..134e6e2e Binary files /dev/null and b/su2gui_files/User_guide/initialization/loaded-restart-file.png differ diff --git a/su2gui_files/User_guide/initialization/loaded-uniform-initialize.png b/su2gui_files/User_guide/initialization/loaded-uniform-initialize.png new file mode 100644 index 00000000..d153aaa6 Binary files /dev/null and b/su2gui_files/User_guide/initialization/loaded-uniform-initialize.png differ diff --git a/su2gui_files/User_guide/mesh/button-mesh-file.png b/su2gui_files/User_guide/mesh/button-mesh-file.png new file mode 100644 index 00000000..2df21402 Binary files /dev/null and b/su2gui_files/User_guide/mesh/button-mesh-file.png differ diff --git a/su2gui_files/User_guide/mesh/choose-mesh-file.png b/su2gui_files/User_guide/mesh/choose-mesh-file.png new file mode 100644 index 00000000..e3ff3e47 Binary files /dev/null and b/su2gui_files/User_guide/mesh/choose-mesh-file.png differ diff --git a/su2gui_files/User_guide/mesh/loaded-mesh-file.png b/su2gui_files/User_guide/mesh/loaded-mesh-file.png new file mode 100644 index 00000000..5d67b1e8 Binary files /dev/null and b/su2gui_files/User_guide/mesh/loaded-mesh-file.png differ diff --git a/su2gui_files/User_guide/result-analysis/geometry-tab.png b/su2gui_files/User_guide/result-analysis/geometry-tab.png new file mode 100644 index 00000000..dfc9ed6e Binary files /dev/null and b/su2gui_files/User_guide/result-analysis/geometry-tab.png differ diff --git a/su2gui_files/User_guide/result-analysis/history-tab.png b/su2gui_files/User_guide/result-analysis/history-tab.png new file mode 100644 index 00000000..bdb2150a Binary files /dev/null and b/su2gui_files/User_guide/result-analysis/history-tab.png differ diff --git a/su2gui_files/User_guide/result-analysis/monitoring-history-lines.png b/su2gui_files/User_guide/result-analysis/monitoring-history-lines.png new file mode 100644 index 00000000..31c54f68 Binary files /dev/null and b/su2gui_files/User_guide/result-analysis/monitoring-history-lines.png differ diff --git a/su2gui_files/User_guide/workflow.png b/su2gui_files/User_guide/workflow.png new file mode 100644 index 00000000..efb1c955 Binary files /dev/null and b/su2gui_files/User_guide/workflow.png differ