Configuration overview

This section describes CARS main configuration structure through a yaml or json configuration file.

Only the configuration file is required to launch CARS with the command :

cars config.yaml

A simple configuration file only needs two sections : input and output. It is not recommended to use the other sections at first use : the default value of their parameters will work for most basic use cases.

The full structure follows this organization:

YAML JSON Copy

input: {}           # the parameters that define what CARS will take as input

orchestrator: {}    # the parallelization/system parameters

output: {}          # the output directory and files

pipeline: auto      # the parameter that selects which pipeline or meta-pipeline CARS should run

pipeline_name_1:    # the parameters for one of the pipelines ran by CARS
  applications: {}  # the parameters for the applications in this pipeline
  advanced: {}      # the parameters of this pipeline

pipeline_name_2: {} # the parameters for another one of the pipelines ran by CARS

{
    "input": {},
    "orchestrator": {},
    "output": {},
    "pipeline": "auto",
    "pipeline_name_1": {
        "applications": {},
        "advanced": {}
    },
    "pipeline_name_2": {}
}

Each section has a dedicated page where every parameter is documented.