Skip to content

QuAM Installation

1⃣ Pre-requisites

Using a virtual environment

It is recommended to install QuAM in a Python virtual environment.

If using Anaconda, this can be done via

conda create -n {environment_name}  
conda activate {environment_name}

Be sure to replace {environment_name} with a name of your choosing

To create a virtual environment without Anaconda, open PowerShell , navigate to a folder where you would like to create a virtual environment, and execute the following command:

python -m venv {environment_name}  
source {environment_name}\Scripts\Activate.ps1
Using a virtual environment

It is recommended to install QuAM in a Python virtual environment.
To create a virtual environment, open terminal , navigate to a folder where you would like to create a virtual environment, and execute the following command: 

python -m venv {environment_name}
source {environment_name}/bin/activate

  • QuAM has not been tested on Linux. However, it should follow similar instructions as MacOS.

2⃣ Installation

QuAM can be installed directly using pip or by cloning the repository from GitHub.

The easiest way to install QuAM is directly using pip:

pip install git+https://github.com/qua-platform/quam.git

Developer installation from Git

Alternatively, The QuAM repository can be downloaded using Git. Open Powershell / terminal in a desired installation folder and run the following command: 

git clone https://github.com/qua-platform/quam.git
pip3 install ./quam

Installation from a Git GUI

If you're not using Git directly but a Git client, please clone the repository from https://github.com/qua-platform/quam.git.
Then open Powershell / terminal , navigate to the downloaded folder quam and run

pip3 install .
Error message "command not found: pip3"

In case the error message command not found: pip3 is displayed, try using the alternative command 

pip install ./quam
If this raises a similar error, it likely means that Python cannot be found. Please check that you have Python installed. If you've set up a virtual environment, please ensure that it has been activated (see Pre-requisites).

3⃣ Next Steps

QuAM comes with a range of standard QuAM components that can kick-start experimental setups. An example of these components are used can be found at the QuAM demonstration.

Beyond the standard components, QuAM provides a framework to create custom components that are tailored to a specific quantum setup. This allows you to create their own abstraction layers, enabling you to digitally represent and interact with your quantum setup. See Creating custom QuAM components for details