Common v6.0.2

Quantum Origin is designed such that each individual adaptor generally shares a common ‘Core’ processing engine.

This means, whilst the individual integrations perform very different tasks, they can often be configured and used in a similar manner.

Most integrations, with some exceptions, support configuration via file-based configuration files, generally called the “config” file in documentation.

This takes configurations options that are common to all relevant integrations, and as such, their documentation is provided within this “Common” section of the documentation, to reduce repetition.

Where an adaptor uses configuration methods other than those explained within the “Common” section, that is further detailed within each adaptor’s documentation directly.

Configuration files

The configuration file takes a consistent format, with its common data being either top-level or one-level indented.

An example is shown below:

wsr:
    type: RDSEED

cache:
    type: none

logging:
    level: error
    mode: stderr

license: >
    [...]

Specification

Note

It is recommended you use the automatic config generator for most use-cases, see: Automatic config generator

For many integrations, some configuration values are hard-coded and not modifiable in the config. This is explained within the relevant integrations.

The specification for the configuration file is shown below, the following interpretation is used:

  1. [value | value | ...]: One of the listed literal case-insensitive strings must be used.

  2. [#non-negative integer | #positive integer | #file]: The type described must be used.

  3. [iff [condition] ->]: This option is mandatory when the condition is met. When it is not met, this option must be omitted.

  4. [?]: Optional configuration option, only to be used in specific circumstances.

wsr:
    type: [rdseed | qo_jitter | jitter | file | callback]
    [iff type is one of [file | jitter] ->] path: [#file]

cache:
    type: [none | caching | synchronous-caching | multithread-caching]
    [iff type is one of [caching | synchronous-caching | multithread-caching] ->] size: [#non-negative integer]
    [iff type is one of [caching | synchronous-caching | multithread-caching] ->] prefill: [#non-negative integer]
    [iff type is one of [caching | synchronous-caching | multithread-caching] ->] refill_at: [#non-negative integer]
    [iff type is multithread-caching ->] threads: [#positive integer]

logging:
    level: [off | none | critical | error | warning | info | debug | trace]
    mode: [stderr | stdout | file | event_log | syslog | inherit | daily_file]
    [iff mode is one of [file | daily_file] ->] path: [#file]


license: >
    [#[base64-encoded string provided directly by Quantinuum]]

# Note, the following options should only be used in exceptional circumstances, consult the documentation for further information.
# When omitted, defaults to health tests enabled.
[?] health_tests:
    disabled: [false (default if omitted) | true]