Skip to content

Configuration File

Config File Location

The QUAlibrate configuration file is a TOML file that contains all the settings for the QUAlibrate software. It is located at ~/.qualibrate/config.toml.

It can be generated using the command

qualibrate config

Command Line Options

This is a list of all the command line options available for the qualibrate config command. These arguments can also be found by calling qualibrate config --help

--config-path

Path to the configuration file. If the path points to a file, it will be read and the old configuration will be reused, except for the variables specified by the user. If the file does not exist, a new one will be created. If the path points to a directory, a check will be made to see if files with the default name exist. The default file names are:

  1. qualibrate.toml - a project-specific configuration file
  2. config.toml - a general qualibrate configuration file If a project-specific configuration file exists, it will be used.

If a project-specific configuration file does not exist, a general configuration file will be checked. If both files are not found in the directory, a general configuration file will be created in the directory.

Default: ~/.qualibrate/config.toml

--auto-accept

Flag responsible for whether to skip confirmation of the generated config.

If the flag is specified in the invoked command, the configuration will be written to the file without confirmation by the user. If the flag is not used, the user will be shown the generated config based on: 1) the old config file, if it existed; 2) default values; 3) values entered by the user. Confirmation will also be requested whether the file was generated correctly.

--password

Password used to authorize users.

By default, no password is used. Everyone has access to the API. If a password is specified during configuration, you must log in to access the API.

Default: None
Config entry: qualibrate_composite.password

--spawn-runner

This flag indicates whether the qualibrate-runner service should be started. This service is designed to run nodes and graphs. The service can be spawned independently.

Default: True
Config entry: qualibrate_composite.runner.spawn

--runner-address

Address of qualibrate-runner service. If the service is spawned by the qualibrate then the default address should be kept as is. If you are running the service separately, you must specify its address.

Default: http://localhost:8001/execution
Config entry: qualibrate_composite.runner.address

--runner-timeout

Maximum waiting time for a response from the qualibrate-runner service.

Default: 1.0
Config entry: qualibrate_composite.runner.timeout

--runner-calibration-library-resolver

String contains python path to the class that represents qualibration library.

Default: "qualibrate.QualibrationLibrary"
Config entry: qualibrate_runner.calibration_library_resolver

--runner-calibration-library-folder

Path to the folder contains calibration nodes and graphs.

Default: ~/.qualibrate/calibrations
Config entry: qualibrate_runner.calibration_library_folder

--spawn-app

This flag indicates whether the qualibrate-app service should be started. This service is designed to getting info about snapshots. The service can be spawned independently.

Default: True
Config entry: qualibrate_composite.app.spawn

--app-static-site-files

Path to the frontend build static files.

Default: <env_libs_path>/qualibrate_static
Config entry: qualibrate_app.static_site_files

--storage-type

Type of storage. Only local_storage is supported now. Use specified local path as the database.

Default: "local_storage"
Config entry: qualibrate.storage.type

--storage-location

Path to the local user storage. Used for storing nodes output data. ${...} - config reference.

Default: ~/.qualibrate/user_storage/${#/qualibrate/project}
Config entry: qualibrate.storage.location

--project

The name of qualibrate app project that will be used for storing runs results and resolving them.

Default: "init_project"
Config entry: qualibrate.project

--quam-state-path

The path to the directory where the active machine state should be stored.

Default: None
Config entry: quam.state_path

--log-folder

The path to the directory where the logs should be stored to.

Default: QUALIBRATE_PATH / "logs" Config entry: qualibrate.log_folder

Environment Variable Override

You can override the default configuration file path by setting the QUALIBRATE_CONFIG_FILE environment variable. This is useful when you want to use multiple configurations or keep your config in a non-standard location.

Usage

Set the QUALIBRATE_CONFIG_FILE environment variable to the path of your config file:

Linux/macOS - Bash/Zsh: 

export QUALIBRATE_CONFIG_FILE=/path/to/your/config.toml
qualibrate config

Windows - Command Prompt (cmd.exe): 

set QUALIBRATE_CONFIG_FILE=C:\path\to\your\config.toml
qualibrate config

To set this permanently, use: 

setx QUALIBRATE_CONFIG_FILE C:\path\to\your\config.toml

Windows - PowerShell: 

$env:QUALIBRATE_CONFIG_FILE = "C:\path\to\your\config.toml"
qualibrate config

To set this permanently in PowerShell, use: 

[Environment]::SetEnvironmentVariable("QUALIBRATE_CONFIG_FILE", "C:\path\to\your\config.toml", "User")

Priority

When loading the configuration: 1. If QUALIBRATE_CONFIG_FILE environment variable is set, it is used 2. Otherwise, the default location ~/.qualibrate/config.toml is used

The environment variable takes precedence over the default path.

Use Cases

  • Multiple configurations: Maintain separate configs for different projects or environments
  • Custom locations: Store config files in a custom directory outside ~/.qualibrate
  • Docker/CI environments: Set the path dynamically in containerized or automated setups
  • Team workflows: Share a common config location for team members