Skip to content

Configuration File

ICON uses a YAML configuration file, located at ~/.config/icon/config.yaml by default. You can override this path with the -c flag.

  • If the file does not exist, ICON will create it with default values.
  • You can adjust settings either in the file or through the frontend settings page.

Databases

  • HDF - file format of the experiment results. Each experiment job gets its own HDF file. The result directory defaults to "$(pwd)/output" and can be configured in the configuration file:

    data:
      results_dir: /my/results/output/dir/
    

  • SQLite - stores metadata about jobs and devices. By default, ICON will create icon.db in the current working directory. You can override this path in the config file:

    databases:
      sqlite:
        file: /my/custom/sqlite/path/icon.db
    
  • InfluxDB - stores parameter time series. Both InfluxDB v1 and v2 are supported (v3 may work but is untested).

    databases:
      influxdbv1:
        database: testing
        host: localhost
        measurement: Experiment Parameters
        password: passw0rd
        port: 8086
        username: tester
        ...
    
    databases:
      influxdbv1:
        database: testing
        host: localhost
        measurement: Experiment Parameters
        password: <influxdb v2 token>
        port: 8086
        ...