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.

Prerequisites

myQLM is installed using the Package Installer for Python (or pip). Please ensure pip command is installed on your machine (if not, you can download pip here) and that myQLM is installable on your computer (by looking at the compatibility matrix below)

Compatibility Matrix

OS \ Python 1

3.6

3.7

3.8

3.9

3.10

Linux 2

✓

✓

✓

✓

Windows 2

✓

✓

✓

✓

✓

macOS 3

✓

✓

✓

✓

✓
1

64-bit versions only

2(1,2)

Only x86_64 architectures are supported

3

Only python.org and brew python distributions are supported. Using python brew distribution while the same version(*) installed from python.org will cause a segmentation fault. In this situation, please use the one from python.org or uninstall it before using the one from brew. (*) version being major.minor - e.g. 3.9

Install

Install myQLM package

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

pip install myqlm
myQLM with Jupyter

myQLM comes with interactive tutorials (or notebooks). Your environment needs to be configured to use all advanced features provided by myQLM:

  • Install Jupyter: myQLM notebooks are designed to work with jupyter. You can install jupyter by typing the following command:

    pip install jupyter

  • Install ImageMagick for wand: myQLM uses wand library to display quantum circuits. Please follow the wand installation guide to install this python library

  • Install Ghostscript for PDF: myQLM can display circuit in PDF format. If Ghostscript is not already installed, please follow the Ghostscript download page to install this program

  • Install myQLM magics: myQLM provides a magic %qatdisplay to display circuit inside a jupyter notebook. These magics can be installed using the following command:

    python -m qat.magics.install

myQLM is now configured for jupyter. Please download myQLM notebooks here and start the notebook overview.ipynb, this notebook contains a table of content of all our tutorials.

Interoperability

Warning

Interoperability packages are deprecated for Python versions 3.6 and 3.7

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[qiskit_binder]

pip install myqlm-interop[projectq_binder]

pip install myqlm-interop[cirq_binder]

pip install myqlm-interop[pyquil_binder]

Warning

Dependencies of these frameworks could conflict. Installing myQLM-interop for all these framework can fail

pip install myqlm-interop[all]