Installation on MacOS

For MacOS, the Quantum Origin SDK is provided in a .tar.gz archive. Extract this file to a new folder of your choice.

Installing

Once extracted, run the script qo-sdk-setup-environment.sh that will copy the library and header files to their correct locations, as described below.

$ chmod +x qo-sdk-setup-environment.sh
$ sudo ./qo-sdk-setup-environment.sh

Installed Folders and Files

On MacOS based-platforms, the installed files are all within the /usr/local directory.

Specifically:

Item(s)

Directory

Implementation (libraries)

/usr/local/lib/

Interface (header files)

/usr/local/include/quantum_origin/

Implementation (libraries)

/usr/local/lib/libquantum_origin_sdk.dylib
/usr/local/lib/libquantum_origin_sdk.<VERSION>.dylib

Interface (header files)

/usr/local/include/quantum_origin/quantum_origin_sdk_c.h

Sample code

The sample code on MacOS systems is located within the extracted .tar.gz file

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

These files are required but are supplied separately by Quantinuum (or your vendor):

quantum_origin_config.yml
quantum_origin_license.h

Sample code - Build Scripts

qosdk_samples_build.sh
qosdk_samples_run.sh

Please see the Sample Code 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.