Qiskit C++ provides a modern C++ (version C++ 11 or later) interface of Qiskit for circuit building, (transpilation and returning samples of quantum circuit outputs ... to be added in the future release), as same as Qiskit Python interfaces. This interface is based on Qiskit C-API introduced in Qiskit 2.1.

• Linux

  • AlmaLinux 9
  • Amazon Linux 2023
  • RedHat Enterprise Linux 8
  • RedHat Enterprise Linux 9
  • SuSE 15
  • Ubuntu 22.04
  • Ubuntu 24.04

• macOS

  • Sequoia 15.1 or above

• Windows

• API Docs
• Getting Started
• Contributing
• License

Before building Qiskit C++, install Qiskit 2.1 or later and build Qiskit C extension library https://github.com/Qiskit/qiskit/tree/main/crates/cext

$ git clone git@github.com:Qiskit/qiskit.git $ cd qiskit $ make c 

Qiskit C++ only has C++ header files. There is nothing to do to build the SDK.

Examples are available in this directory.

To build application using Qiskit C++, add path to Qiskit C-API, include path to qiskit.h (installed in dist/c/include) and library libqiskit.so (installed in dist/c/lib) or qiskit_cext.dll.lib (generated in target/release) for Windows. See ./CMakeLists.txt for example to make test program.

$ mkdir build $ cd build $ cmake -DQISKIT_ROOT=Path_to_qiskit .. $ make 

If you want to build sampler example, you will need QRMI C-API.

$ git clone git@github.com:qiskit-community/qrmi.git $ cd qrmi $ cargo build --release 

Then example can be built by setting QRMI_ROOT,

$ mkdir build $ cd build $ cmake -DQISKIT_ROOT=Path_to_qiskit -DQRMI_ROOT=Path_to_QRMI .. $ make 

To run sampler example, set following environment variables to access Quantum hardware.

QISKIT_IBM_TOKEN=<your API key> QISKIT_IBM_INSTANCE=<your CRN> 

By default, Qiskit C++ uses QRMI (https://github.com/qiskit-community/qrmi) to access Quantum computers through IBM Qiskit Runtime Service. To use other services of interfaces, prepare your own backend interface from the BackendV2 base class (./src/providers/backend.hpp) Refer to ./src/providers/qrmi_backend.hpp for details.

Regardless if you are part of the core team or an external contributor, welcome and thank you for contributing to Qiskit C++

Contributor must execute the commands below and fix any issues before submitting Pull Request.

Contributor must execute the command below and fix any issues before submitting Pull Request.

Contributor can generate API document from source.

$ doxygen Doxyfile 

API document will be created under html directory.

Apache License 2.0