Skip to content

Commit cd1a7ef

Browse files
authored
Update Configuration-File.md
1 parent 712b607 commit cd1a7ef

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

_docs_v7/Configuration-File.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The configuration file is a text file that contains a user's options for a parti
77

88
The SU2 configuration file name typically carries a name of the form *filename.cfg*. The file extension .cfg is optional (this is our own convention), and the prefix can be any valid string with no spaces; e.g. config.cfg, su2-config.cfg, and flow_config.cfg are all suitable file names.
99

10-
**Note: An example configuration file, called config_template.cfg, can be found in the root SU2/ directory. The developers keep this file up to date with the latest options, and it serves as the first reference for the available options in SU2**
10+
**Note: An example configuration file, called config_template.cfg, can be found in the root SU2/ directory or [here](https://github.com/su2code/SU2/blob/master/config_template.cfg). The developers keep this file up to date with the latest options, and it serves as the first reference for the available options in SU2**
1111

1212
The configuration file consists of only three elements:
1313
- **Options**. An option in the file has the following syntax: option_name = value, where option_name is the name of the option and value is the desired option value. The value element may be a scalar data type, a list of data types, or a more complicated structure. The "=" sign must come immediately after the option_name element and is not optional. Lists of data types may be formatted for appearance using commas, ()-braces, {}-braces, and []-braces, though this is not required. Semicolons are semantically relevant for several option types and may not be used as convenience delimiters. SU2 will exit with an error if there are options in the config file which do not exist or if there are options with improper formatting. Some example option formats are given below.

0 commit comments

Comments
 (0)