Installation on Windows¶

Installing¶

For Windows, the Quantum Origin SDK installer can be run either interactively, or silently/unattended:

Command line options:¶

    quantum_origin_sdk_windows_<ARCH>_Release-v<VERSION>_installer.exe  [/?] [/S] [/NoDevFiles] [/NoSampleCode] [/NoStartMenuShortcuts] [/NoUserSampleCode]

       Where the options are:
           /?                    : Help (This help)
           /S                    : Silent/Unattended install (uninstaller supports this too)
           /NoDevFiles           : Do not install the "Development Files" (implib and header files)
           /NoSampleCode         : Do not install the sample code
           /NoStartMenuShortcuts : Do not create the StartMenu shortcuts
           /NoUserSampleCode     : Do not install a copy of sample code in the user's home directory

.. ------------------------------------------------------------------------------------------------------------------------ '

Notes:

The runtime DLL is always installed.
In the case of a silent install, the various /NoXxxx options are used to specify which components to include in the install. By default all options are included in the install.
In the case of a normal interactive install, these /NoXxxx options are used to set the default values. The user is still presented with a feature selection dialog where these default values can still be adjusted.
The core files are installed into “C:\Program Files” for use by all users, so elevated privileges are required for the install.
If the installer is launched from a non-administrator shell, Windows will prompt interactively for permission to proceed.

So, in its simplest form, to install the SDK, enter the following…

Interactive:¶

quantum_origin_sdk_windows_<ARCH>_Release-v<VERSION>_installer.exe

…and then follow the instructions on the screen.

Silent:¶

quantum_origin_sdk_windows_<ARCH>_Release-v<VERSION>_installer.exe /S

After which the return code will be non-zero if there is a problem, or zero if successful.

Installed Folders and Files¶

On Windows platforms the installed files are in C:\\Program Files\\Quantinuum\\quantum_origin_sdk\\, with an optional editable copy of the sample code copied into a working directory of the current user: %USERPROFILE%\\source\repos\\quantum_origin_sdk\\sample_code\\.

Specifically:

Item(s)	Directory
Implementation (DLL)	C:\Program Files\Quantinuum\quantum_origin_sdk\bin\
Implementation (ImpLib)	C:\Program Files\Quantinuum\quantum_origin_sdk\lib\
Interface (header files)	C:\Program Files\Quantinuum\quantum_origin_sdk\include\quantum_origin\
Documents	C:\Program Files\Quantinuum\quantum_origin_sdk\doc\
Sample code (Reference)	C:\Program Files\Quantinuum\quantum_origin_sdk\sample_code\
Sample code (Editable)	%USERPROFILE%\source\repos\quantum_origin_sdk\sample_code\

Implementation (libraries)¶

"C:\Program Files\Quantinuum\quantum_origin_sdk\bin\quantum_origin_sdk.dll"
"C:\Program Files\Quantinuum\quantum_origin_sdk\lib\quantum_origin_sdk.lib"

Interface (header files)¶

"C:\Program Files\Quantinuum\quantum_origin_sdk\include\quantum_origin\quantum_origin_sdk_c.h"

Documents¶

"C:\Program Files\Quantinuum\quantum_origin_sdk\doc\LEGAL_LICENSE"
"C:\Program Files\Quantinuum\quantum_origin_sdk\doc\README.txt"

Sample code¶

The sample code on Windows systems is located at:

Reference: C:\Program Files\Quantinuum\quantum_origin_sdk\sample_code\
Editable: %USERPROFILE%\source\repos\quantum_origin_sdk\sample_code\

Sample code - Documentation¶

README.txt

Sample code - Sources¶

qosdk_sample_code_A_using_config_file.c
qosdk_sample_code_B_using_setopt_api.c
qosdk_sample_code_C_minimal_get32bytes.c
qosdk_sample_code_D_minimal_coinflip.c
qosdk_sample_code_E_minimal_get32bytes_using_setopt_api.c
qosdk_sample_code_F_minimal_coinflip_using_setopt_api.c

Sample code - License Files¶

Required, but supplied separately by Quantinuum (or your vendor):

quantum_origin_config.yml
quantum_origin_license.h

Sample code - Build Scripts¶

build_and_run_samplecode.bat
Makefile
conanfile.py
CMakeLists.txt

Sample code - Environment Variables¶

(Installation specific. Created by the installer.)

envvars.bat

Please see the Sample Code<sdk_sample_code_start> section for details of how to build the supplied sample code.

Furthermore, there is a README file in the sample_code directory which contains further information on building and executing the sample code. This is useful as a confirmation that the installation has been a success, but also as a useful starting point for ones own development or integration.