Skip to content

Commit cc5a6b8

Browse files
authored
Update README.md
1 parent 4e40c44 commit cc5a6b8

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,13 @@ Computational analysis tools have revolutionized the way we design aerospace sys
1212

1313
SU2 provides an extensive collection of common test cases. The test cases contain meshes and configuration files that can be run to ensure different components of the suite are working properly. The directory structure is organized by governing equations and their specific cases.
1414

15-
The files found within these directories serve three purposes:
15+
The files found within these directories serve two purposes:
1616

1717
1. A subset of the available cases are used for regression testing internally by the development team. The configuration files and meshes are automatically downloaded and executed with the latest version of SU2 at regular intervals. Any changes in the output of the specified test cases are immediately reported to the developers. These cases are controlled by the Python scripts in the root of the test cases directory, e.g., serial_regression.py.
1818

19-
2. A subset of the available cases contain the configuration files and meshes that are required for the written tutorials found in the SU2 documentation (see https://github.com/su2code/SU2/wiki).
19+
2. The entire suite of test cases is provided to the community as a way to get started with SU2 and its many configuration options, including settings that the developers consider to be good starting points. Often, you will find a test case that is similar to your problem of interest, and the available configuration files can be modified to suit your needs.
2020

21-
3. The entire suite of test cases is provided to the community as a way to get started with SU2 and its many configuration options, including settings that the developers consider to be good starting points. Often, you will find a test case that is similar to your problem of interest, and the available configuration files can be modified to suit your needs.
22-
23-
Note that, while many of the cases are used for regression testing, this test case suite is provided without any guarantees on performance or expected results. Keep in mind that small changes to the configuration options can often result in large changes to the output. We encourage the community to experiment with these test cases, or even try (and share!) other interesting validation cases with SU2!
21+
Note that, while many of the cases are used for regression testing, this test case suite is provided **without any guarantees on performance or expected results** (check out the [tutorials](https://su2code.github.io/Tutorials/) for more thoroughly maintained cases). Keep in mind that small changes to the configuration options can often result in large changes to the output. We encourage the community to experiment with these test cases, or even try (and share!) other interesting validation cases with SU2!
2422

2523
Happy testing!
2624

0 commit comments

Comments
 (0)