Tergite Backend (formerly Tergite BCC)

The Backend in the Tergite software stack of the WACQT quantum computer.

This project is developed by a core group of collaborators.
Chalmers Next Labs AB (CNL) takes on the role of managing and maintaining this project.

Version Control

The tergite stack is developed on a separate version control system and mirrored on Github. If you are reading this on GitHub, then you are looking at a mirror.

Dependencies

• Python 3.12
• Redis

Quick Start

• Ensure you have conda installed. (You could simply have python +3.12 installed instead.)
• Ensure you have the Redis server running
• Clone the repo

git clone git@github.com:tergite/tergite-backend.git

• Create conda environment

conda create -n bcc -y python=3.12
conda activate bcc

• Install dependencies

cd tergite-backend
pip install ."[dev]"

• Copy the dot-env-template.txt file to .env and update the environment variables there appropriately.

cp dot-env-template.txt .env

Note: If you want to run without a running MSS, set the variable IS_STANDALONE=True in the .env
Note: If you don't want to use the simulator, set the variable EXECUTOR_TYPE=quantify in the .env

• If you have EXECUTOR_TYPE=quantify, copy the quantify example config file quantify-config.example.json and quantify-metadata.example.yml into the quantify-config.json and quantify-metadata.yml file and update the variables there in.
  Ignore this if you are using the qiskit pulse simulator

cp quantify-config.example.json quantify-config.json
cp quantify-metadata.example.yml quantify-metadata.yml 

Note: If you want to just run a dummy cluster, you can copy the one in the test fixtures

cp app/tests/fixtures/generic-quantify-config.yml quantify-config.json
cp app/tests/fixtures/generic-quantify-config.json quantify-metadata.yml

• Copy the backend example config file backend_config.example.toml into the backend_config.toml file and update the variables there in.

cp backend_config.example.toml backend_config.toml

Note: If you are running the simulator, you can copy the one in the test fixtures

cp app/tests/fixtures/backend_config.simq1.toml backend_config.toml

• Copy the example file for initial device calibrations calibration.seed.example.toml into the calibration.seed.toml file and update the variables accordingly.

cp calibration.seed.example.toml calibration.seed.toml

• Run start script

./start_bcc.sh

• Open your browser at http://localhost:8000/docs to see the interactive API docs

Documentation

Find more documentation in the docs folder

Contribution Guidelines

If you would like to contribute, please have a look at our contribution guidelines

Authors

This project is a work of many contributors.

Special credit goes to the authors of this project as seen in the CREDITS file.

ChangeLog

To view the changelog for each version, have a look at the CHANGELOG.md file.

License

Apache 2.0 License

Acknowledgements

This project was sponsored by:

• Knut and Alice Wallenberg Foundation under the Wallenberg Center for Quantum Technology (WACQT) project at Chalmers University of Technology
• Nordic e-Infrastructure Collaboration (NeIC) and NordForsk under the NordIQuEst project
• European Union's Horizon Europe under the OpenSuperQ project
• European Union's Horizon Europe under the OpenSuperQPlus project