|
1 | 1 | --- |
2 | | -title: Introduction to SU2GUI |
| 2 | +title: Welcome to SU2GUI |
3 | 3 | permalink: /su2gui/Introduction/ |
4 | 4 | --- |
5 | 5 |
|
6 | | -**SU2GUI** is a Graphical User Interface (GUI) for the SU2 open-source CFD software. It facilitates easier execution of SU2 tasks and provides visualization capabilities for the results. |
7 | | -Please note that SU2GUI is currently under development. We welcome feedback and contributions to improve the tool. SU2GUI is under active development by individuals all around the world on GitHub and is released under an open-source license. |
| 6 | +**Welcome to SU2GUI!** |
8 | 7 |
|
| 8 | +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. |
9 | 9 |
|
10 | | -## Overview of SU2GUI Workflow |
| 10 | +## Why Use SU2GUI? |
11 | 11 |
|
12 | | -Here is an overview of how SU2GUI works: |
| 12 | +- **User-Friendly Interface:** Navigate complex simulations with ease. |
| 13 | +- **Real-Time Visualization:** See results as they happen, enabling quick adjustments. |
| 14 | +- **Comprehensive Case Management:** Organize, load, and manage your simulations effortlessly. |
13 | 15 |
|
14 | | - |
| 16 | +## Explore the SU2GUI Workflow |
15 | 17 |
|
| 18 | +Here’s a snapshot of how SU2GUI simplifies your work: |
16 | 19 |
|
17 | | -SU2GUI is designed to simplify and streamline the process of setting up, running, and analyzing simulations with SU2. 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. Below is a typical workflow when using SU2GUI: |
| 20 | + |
18 | 21 |
|
19 | 22 | ### 1. Launch SU2GUI |
20 | | -Start the application by running the `su2gui` command in your terminal. This opens the graphical user interface where all operations are conducted. |
| 23 | +Get started by running the `SU2_GUI` command in your terminal. This opens up the graphical interface where operations are conducted. |
21 | 24 |
|
22 | | -### 2. Load Your Case |
23 | | -Once SU2GUI is launched, use the interface to load your Case along with the necessary files such as mesh, configuration, and other relevant configurations. The GUI allows for easy management and organization of these files, ensuring that your simulation is properly set up. |
| 25 | +### 2. Start Your Case |
| 26 | +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. |
24 | 27 |
|
25 | | -### 3. Run Simulation |
| 28 | +### 3. Run Your Simulation |
26 | 29 | 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. |
27 | 30 |
|
28 | 31 | ### 4. Visualize Results |
29 | 32 | 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. |
30 | 33 |
|
31 | | -### 5. Manage Cases |
32 | | -SU2GUI also offers robust case management features. You can easily delete, download, or load new or previous cases, providing you with greater control over your simulation projects and data. |
| 34 | +### 5. Manage Your Cases |
| 35 | +Easily manage your simulation projects with SU2GUI’s case management features. Download, delete, or switch between cases with just a few clicks. |
33 | 36 |
|
| 37 | +## Ready to Get Started? |
34 | 38 |
|
35 | | -For a more detailed understanding of how to use SU2GUI, refer to the [QuickStart page](./../quick-start). |
| 39 | +Dive deeper with our [QuickStart guide](./../Quick-Start) and get started with SU2GUI. |
0 commit comments