Introduction¶

Section summary

This section provides information to those directly involved in the technical roll-out and usage of Quantum Origin products. For example, IT teams, software engineers and software architects.

This page provides technical direction that explains the structure of Quantum Origin. This includes how to install, configure and use our software offerings, as well as troubleshooting and FAQs for each integration.

Structure of Quantum Origin¶

Quantum Origin uses a ‘Common Core’ which is embedded into a range of use-case specific software programs that we call “integrations”.

The Common Core contains the essential functionality that all integrations rely upon, including a common set of configuration options. The Common Core is versioned and each version of an integration is paired with a specific version of the Common Core.

Integrations add the additional behavior required to fulfill their technical purpose, and integrations are individually installable, configurable and usable.

Each integration will define the method of configuration, and may set defaults or restrict configuration from the broader Common Core. For example, service-based integrations will contain additional configuration for their service which is absent in non-service-based integrations such as the Command Line Interface (CLI).

Using these User Guides¶

Tip

If you are uncertain as to which integration to install, please review the Find your integration page.

If you are installing a Quantum Origin integration, the first thing to do is select your relevant integration and ensure you are reviewing the correct version of the documentation.

The integration will specify which version of the Common Core it uses. You may need to cross-reference certain information across to the Common Core documentation page for complete documentation.

The top level-page (e.g. “CLI”), rather than an item in the sub-menu will provide a summary for that tool.

The version number is displayed prominently at the top of the section. If you are installing a previous release, ensure you click “Releases” and then select your relevant version.

Many integrations are available for a broad range of operating systems, select the relevant tabbed entry on your integration page for instructions for your operating system.

Each integration has a consistent layout, with the following sections:

Top-level summary page: A technical introduction to the tool, including a “Quick Start” guide.
Installation: An end-user installation guide for installation of the specific released installers or executables on a per-platform basis.
Configuration and Use: How to configure each integration, and use it with typical real-world examples. This section will be structured appropriately for each integration.
Troubleshooting: Guidance on how to resolve common challenges.
Releases: Release notes, as well as a drop-down providing access to previous releases of the documentation for that integration.

The reader is advised to read the summary page and review the “Quick Start” guide to gain an initial understanding of the steps required.