Configuration

General Version Logging Collision term Modi Output Lattice Potentials Forced Thermalization

SMASH is configured via an input file in YAML format. Typically you will start from the supplied config.yaml file and modify it according to your needs. If you ever make a mistake there and specify a configuration key that SMASH does not recognize, then on startup it will tell you about the keys it could not make any sense of.

Attention

By default, SMASH copies the config.yaml file used to set up the SMASH run to the output directory of the simulation. For the sake of reproducibility, the randomly generated number seed (if the user specified a negative seed) is inserted into the copied file. The used particles and decay modes are appended there as well. For this purpose, a particles and a decaymodes key are used and their values are a one-line version of the corresponding files (see Particles and Decay modes for information about them). To manually input the values of these keys is not an intended use case and you are discouraged from doing so. On the other hand, you could use the YAML file copied by SMASH to the output directory for reproducibility purposes. In this case, since particles and decay modes are included in the configuration file, using a particles and/or a decay modes file as well should be avoided, otherwise the configuration content will be ignored.

The available keys are documented on the following pages:

• General
• Logging
• Version
• Collision term
• Modi
• Output
• Lattice
• Potentials
• Forced Thermalization

Note

In the evolution of the software some new input keys have been introduced and some other removed. From SMASH-3.0 a systematic deprecation and removal mechanism has been introduced, such that a key can be marked as deprecated by developer in some version and been removed in a later release. Therefore, it can be easily read in the code in which version a key has been introduced, deprecated or removed. Refer to the documentation of the InputKeys class in the developer guide for further information.

Information on formatting of the input file

The input file is made of sections, i.e. of keys containing as "value" a series of keys and/or sections. In order to identify the content of a section, it is important to keep a consistent indentation in the input file. The convention is to use 4 spaces indentation in order to specify keys inside a section. For example:

Output:
    Output_Interval: 1.0
    Particles:
        Format: ["Oscar2013"]

This is a part of the input file. The Output_Interval key belongs to the Output section, whereas Particles is in turn a section containing the Format key.