Installing myQLM

Please read the Atos myQLM End-User Licence Agreement (Atos myQLM EULA) carefully before using myQLM. You are only permitted to use myQLM pursuant to the terms and conditions of this agreement. This agreement is between you and (as an individual or legal entity) and Bull SAS.

By downloading of installing myQLM or otherwise rendering it available for your use, you are agreeing to be bound by the terms of this license. If you do not agree with the terms, do not download, install, copy or otherwise use myQLM. If you have downloaded or installed myQLM and do not agree to the terms, promptly delete myQLM.

Compatibility Matrix

OS \ Python*

3.6

3.7

3.8

3.9

Linux

x

x

Windows

x

x

x

x

macOS**

x

x

x

x

* 64-bit versions only

** Only python.org and brew python distributions are supported

Install Jupyter

myQLM is installed using the Package Installer for Python (or pip). If the pip command is not installed on your machine, you can download pip here.

myQLM comes with interactive tutorials (or notebooks). These tutorials require Jupyter. In order to install Jupyter, please type the following command:

pip install jupyter

Moreover, if you want to display myQLM quantum circuits inside Jupyter notebooks, please install ImageMagick for wand.

Install

Install myQLM wheels

Please install myQLM by typing the following command in a Windows, MacOS or Linux prompt:

pip install myqlm

Install myQLM magics

myQLM provides tools to display quantum circuits inside Jupyter notebooks. These magics can be installed using the following command:

python -m qat.magics.install

Download Jupyter notebooks

myQLM comes with interactive tutorials you can open with Jupyter Notebook. Please download myQLM notebooks here and start the notebook overview.ipynb, this notebook contains a table of content of all our tutorials.

Interoperability

This package enables access to other quantum programming environments such as Qiskit, projectQ, pyQuil, Cirq … This package will not automatically install dependency packages because someone who want to interface with Qiskit may not want to interface with Cirq… The desired quantum environment can be cherry-picked using the pip command:

pip install myqlm-interop[<PACKAGE>_binder]

For Qiskit

pip install myqlm-interop[qiskit_binder]

For ProjectQ

pip install myqlm-interop[projectq_binder]

For Cirq

pip install myqlm-interop[cirq_binder]

For PyQuil

pip install myqlm-interop[pyquil_binder]

For all of them

pip install myqlm-interop[all]