The Global Config

The Global Config#

The main configuration of the framework is located inside vibe/config.yaml. There are several parameters that can be set that will alter how VIBE runs. This includes the actual list of modes that are run. The settings that have the be configured are:

base_path

The location where all the output files of VIBE will be written. Best practice is to make this path point outside of VIBE, one directory above where you have installed it.

b2monitoring_path

The path where the b2monitoring repository was cloned. This is only for needed for run_quality modes, so in most cases you can set it to an empty string.

modes_to_run

In this section one can choose which modes to use when running VIBE.

modes_to_run :
    analysis_validation :
        # 'all' # for all
        null # for no modes
        by_name : #List[str], for modes by name
            - docExampleMode
        # by_group: # : List[str], for modes by group
        #   - physics
    skim_production:
        'all' # for all
        # null # for no modes
        #by_name: #List[str], for modes by name
        #    - name
        # by_group: # : List[str], for modes by group
        #   - slme

There is a bit going on here which needs to be understood. We will break it down level by level

  • Top Level: the level corresponds to the variants of the ModeType enum found in vibe/core/mode.py.

    • analysis_validation

    • skim_production

    • run_quality

  • Mode Type configuration: Underneath the variant there are 4 different options available. only one can be chosen.

    • null: By default every ModeType variant is set to null, meaning no modes of that type will be run.

    • all: If chosen, all modes of this ModeType will be run.

    • by_name: If chosen then the user must list the names of the modes that need to be run.

    • by_group: If chosen, the user must create a list containing the groups they wish to run for that specific mode.

Note

All available analysis validation groups are contained in the DPGroup enum, whilst skim production groups are contained in the SkimWorkingGroup enum.

analysis_validation_light_release

The basf2 light release used for the processing of the steering files on the grid.

Warning

The light release chosen here is only affecting the processing of the datesets on the grid and not the ones run offline. The datasets defined with the additional parameter offline=true are processed with the release that is currently set up locally.

Note

The config.yaml uses a schema defined at vibe/schemas/config_schema.json, which will check that the config file is formatted correctly and all data that has been inputted is as expected.