1 File Format

A Simics script file can either be a YAML file containing parameter and/or argument declarations, with a pointer to a separate file containing code, or have a parameter declaration section in YAML format placed at the top of a file with Simics CLI or Python code.

In the former case, the file format has the following specifications:

• It must start with the YAML 1.2 directive, i.e. %YAML 1.2
• The whole file must be valid YAML.
• It must contain exactly one YAML document.
• The YAML document must have document start marker immediately after the YAML 1.2 directive. The document must contain the parameters, arguments and any other meta-data. This is specified in Section 3.
• The document must have a document end marker.

In the latter case, the file format has the following specifications:

• The file may start with any number of blank lines or comment lines (starting with #), and must be followed by the parameter start marker, which is a line ''' followed by a line %YAML 1.2 (in Python code) or @''' followed by %YAML 1.2 (in Simics CLI code), followed by a line ---
• Some subsequent line must be ''', which marks the end of the parameter block.
• The text between these lines must be valid YAML, a YAML mapping, and must contain the parameters, arguments and any other meta-data. This is specified in Section 3.
• Any text on lines following the ''' line must be code.