Skip to content

Commit e43515d

Browse files
authored
Merge branch 'develop' into release_v7.5.1
2 parents ed26f74 + 559b785 commit e43515d

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
<p align="center">
2-
<img width="250" height="154" src="Common/doc/logoSU2small.png">
2+
<img width="250" height="154" src="Docs/logoSU2small.png">
33
</p>
44

55

66
# SU2 (ver. 7.5.1 "Blackbird"): The Open-Source CFD Code
77

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.
99

1010
For an overview of the technical details in SU2, please see the following AIAA Journal article:
1111

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>
1313

1414
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.
1515

@@ -22,17 +22,17 @@ Code Quality:<br/>
2222

2323
# SU2 Introduction
2424

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.
2626

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.
2828

2929
You will find more information and the latest news in:
30-
- SU2 Home Page: https://su2code.github.io
31-
- GitHub repository: https://github.com/su2code
32-
- CFD Online: http://www.cfd-online.com/Forums/su2/
33-
- Twitter: https://twitter.com/su2code
34-
- Facebook: https://www.facebook.com/su2code
3530

31+
- SU2 Home Page: <https://su2code.github.io>
32+
- GitHub repository: <https://github.com/su2code>
33+
- CFD Online: <http://www.cfd-online.com/Forums/su2/>
34+
- Twitter: <https://twitter.com/su2code>
35+
- Facebook: <https://www.facebook.com/su2code>
3636

3737
# SU2 Installation
3838

@@ -41,7 +41,8 @@ You will find more information and the latest news in:
4141
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).
4242

4343
## 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.
4546

4647
Short summary of the minimal requirements:
4748

@@ -51,9 +52,11 @@ Short summary of the minimal requirements:
5152
**Note:** all other necessary build tools and dependencies are shipped with the source code or are downloaded automatically.
5253

5354
If you have these tools installed, you can create a configuration using the `meson.py` found in the root source code folder:
55+
5456
```
5557
./meson.py build
5658
```
59+
5760
Use `ninja` to compile and install the code
5861

5962
```
@@ -62,11 +65,12 @@ Use `ninja` to compile and install the code
6265

6366
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/).
6467

65-
## SU2 Path setup
68+
## SU2 Path setup
6669

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`.
6871

6972
For example, add these lines to your `.bashrc` file:
73+
7074
```
7175
export SU2_RUN="your_prefix/bin"
7276
export SU2_HOME="/path/to/SU2vX.X.X/"
@@ -82,13 +86,11 @@ Thanks for building, and happy optimizing!
8286

8387
- The SU2 Development Team
8488

85-
8689
# SU2 Developers
8790

88-
8991
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.
9092

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.
9294

9395
A list of current contributors can be found in the AUTHORS.md file.
9496

0 commit comments

Comments
 (0)