Input File Reference

SKPAR is controlled by an input file in YAML. The filename is given as an argument to the skpar command (e.g. skpar skpar_in.yaml). Examples of input files can be seen in Tutorials, while here we provide the full details.

The input file must contain the following four sections, which are covered in this reference. The sections of the reference correspond to sections in the input file.

tasks:
    # tasks defining the model

objectives:
    # objectives steering the optimisation

optimisation:
    # optimisation strategy

# optional
executables:
    # alises of executable commands used in tasks

# optional
config:
    # settings defining work directory layout

• Tasks
  • Set Tasks
  • Run Tasks
  • Get Tasks
    • Available get-functions
    • Source and Destination
    • Optional Arguments
  • Plot Tasks
    • Plot-Task Examples:
• Objectives
  • Overview of Objectives Declaration
  • Details of Objective Declaration
    • Query Label (query)
    • Doc-string (doc)
    • Model Name(s) (models)
    • Reference Data (ref)
    • Objective Weight (weight)
    • Evaluation function (eval)
    • Options (options)
  • Reference Data And Objective Types
    • 1) Single model, single item/1-D array reference data
    • 2) Single model, 2-D array reference data
    • 3) Single model, key-value pairs reference data
    • 4) Multiple models, single item reference data
    • 5) Multiple models, 1-D array reference data
• Optimisation
  • Cost function
  • Optimisation Algorithm
  • Parameter declaration
  • References
• Executables
• Configuration