You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# SU2 (ver. 7.5.1 "Blackbird"): The Open-Source CFD Code
7
7
8
-
Computational analysis tools have revolutionized the way we design engineering systems, but most established codes are proprietary, unavailable, or prohibitively expensive for many users. The SU2 team is changing this, making multiphysics analysis and design optimization freely available as open-source software and involving everyone in its creation and development.
8
+
Computational analysis tools have revolutionized the way we design engineering systems, but most established codes are proprietary, unavailable, or prohibitively expensive for many users. The SU2 team is changing this, making multiphysics analysis and design optimization freely available as open-source software and involving everyone in its creation and development.
9
9
10
10
For an overview of the technical details in SU2, please see the following AIAA Journal article:
11
11
12
-
"SU2: An open-source suite for multiphysics simulation and design," AIAA Journal, 54(3):828-846, 2016. http://arc.aiaa.org/doi/10.2514/1.J053813
12
+
"SU2: An open-source suite for multiphysics simulation and design," AIAA Journal, 54(3):828-846, 2016. <http://arc.aiaa.org/doi/10.2514/1.J053813>
13
13
14
14
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
15
15
@@ -22,17 +22,17 @@ Code Quality:<br/>
22
22
23
23
# SU2 Introduction
24
24
25
-
SU2 is a suite of open-source software tools written in C++ for the numerical solution of partial differential equations (PDE) and performing PDE constrained optimization.
25
+
SU2 is a suite of open-source software tools written in C++ for the numerical solution of partial differential equations (PDE) and performing PDE constrained optimization.
26
26
27
-
The primary applications are computational fluid dynamics and aerodynamic shape optimization, but has been extended to treat more general equations such as electrodynamics and chemically reacting flows.
27
+
The primary applications are computational fluid dynamics and aerodynamic shape optimization, but has been extended to treat more general equations such as electrodynamics and chemically reacting flows.
28
28
29
29
You will find more information and the latest news in:
@@ -41,7 +41,8 @@ You will find more information and the latest news in:
41
41
You can find precompiled binaries of the latest version on our [download page](https://su2code.github.io/download.html) or under [releases](https://github.com/su2code/SU2/releases).
42
42
43
43
## Build SU2
44
-
The build system of SU2 is based on a combination of [meson](http://mesonbuild.com/) (as the front-end) and [ninja](https://ninja-build.org/) (as the back-end). Meson is an open source build system meant to be both extremely fast, and, even more importantly, as user friendly as possible. Ninja is a small low-level build system with a focus on speed.
44
+
45
+
The build system of SU2 is based on a combination of [meson](http://mesonbuild.com/) (as the front-end) and [ninja](https://ninja-build.org/) (as the back-end). Meson is an open source build system meant to be both extremely fast, and, even more importantly, as user friendly as possible. Ninja is a small low-level build system with a focus on speed.
45
46
46
47
Short summary of the minimal requirements:
47
48
@@ -51,9 +52,11 @@ Short summary of the minimal requirements:
51
52
**Note:** all other necessary build tools and dependencies are shipped with the source code or are downloaded automatically.
52
53
53
54
If you have these tools installed, you can create a configuration using the `meson.py` found in the root source code folder:
55
+
54
56
```
55
57
./meson.py build
56
58
```
59
+
57
60
Use `ninja` to compile and install the code
58
61
59
62
```
@@ -62,11 +65,12 @@ Use `ninja` to compile and install the code
62
65
63
66
For more information on how to install and build SU2 on Linux, MacOS or Windows, have a look at the [documentation](https://su2code.github.io/docs_v7/).
64
67
65
-
## SU2 Path setup
68
+
## SU2 Path setup
66
69
67
-
When installation is complete, please be sure to add the `$SU2_HOME` and `$SU2_RUN` environment variables, and update your `$PATH` with `$SU2_RUN`.
70
+
When installation is complete, please be sure to add the `$SU2_HOME` and `$SU2_RUN` environment variables, and update your `$PATH` with `$SU2_RUN`.
68
71
69
72
For example, add these lines to your `.bashrc` file:
73
+
70
74
```
71
75
export SU2_RUN="your_prefix/bin"
72
76
export SU2_HOME="/path/to/SU2vX.X.X/"
@@ -82,13 +86,11 @@ Thanks for building, and happy optimizing!
82
86
83
87
- The SU2 Development Team
84
88
85
-
86
89
# SU2 Developers
87
90
88
-
89
91
We follow the popular "GitFlow" branching model for scalable development. In the SU2 repository, the master branch represents the latest stable major or minor release (7.0, 6.2.0, etc.), it should only be modified during version releases. Work that is staged for release is put into the develop branch via Pull Requests on GitHub from various "feature" branches where folks do their day-to-day work on the code. At release time, the work that has been merged into the develop branch is pushed to the master branch and tagged as a release.
90
92
91
-
SU2 is being developed by individuals and organized teams all around the world.
93
+
SU2 is being developed by individuals and organized teams all around the world.
92
94
93
95
A list of current contributors can be found in the AUTHORS.md file.
0 commit comments