-
Notifications
You must be signed in to change notification settings - Fork 11
/
Usage.rst
39 lines (24 loc) · 984 Bytes
/
Usage.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
Repository Usage
================
There are two ways how to use MQT Predictor:
#. Via the pip package ``mqt.predictor``
#. Directly via this repository
Usage via pip package
---------------------
MQT Predictor is available via `PyPI <https://pypi.org/project/mqt.predictor/>`_
.. code-block:: console
(venv) $ pip install mqt.predictor
To compile a quantum circuit, use the ``qcompile`` method:
.. automodule:: mqt.predictor
:members: qcompile
Currently available figures of merit are ``expected_fidelity`` and ``critical_depth``.
An example how ``qcompile`` is used can be found in the :doc:`quickstart <Quickstart>` jupyter notebook.
.. _pip_usage:
Usage directly via this repository
----------------------------------
For that, the repository must be cloned and installed:
.. code-block::
git clone https://github.com/cda-tum/mqt-predictor.git
cd mqt-predictor
pip install .
Afterwards, the package can be used as described :ref:`above <pip_usage>`.