Q-CTRL Qiskit Adapter
Project description
Q-CTRL Qiskit Adaptor
The aim of the Q-CTRL Qiskit Adaptor package is to provide export functions allowing users to deploy established error-robust quantum control protocols from the open literature and defined in Q-CTRL Open Controls on IBM Quantum hardware.
Anyone interested in quantum control is welcome to contribute to this project.
Table of Contents
Installation
Q-CTRL Qiskit Adaptor can be installed through pip
or from source. We recommend
the pip
distribution to get the most recent stable release. If you want the
latest features then install from source.
Requirements
To use Q-CTRL Qiskit Adaptor you will need an installation of Python. We recommend using the Anaconda distribution of Python. Anaconda includes standard numerical and scientific Python packages which are optimally compiled for your machine. Follow the Anaconda Installation instructions and consult the Anaconda User guide to get started.
We use interactive jupyter notebooks for our usage examples. The Anaconda python distribution comes with editors for these files, or you can install the jupyter notebook editor on its own.
Using PyPi
Use pip
to install the latest version of Q-CTRL Qiskit Adaptor.
pip install qctrl-qiskit
From Source
The source code is hosted on Github. The repository can be cloned using
git clone git@github.com:qctrl/python-qiskit.git
Once the clone is complete, you have two options:
-
Using setup.py
cd python-qiskit python setup.py develop
Note: We recommend installing using
develop
to point your installation at the source code in the directory where you cloned the repository. -
Using Poetry
cd python-qiskit ./setup-poetry.sh
Note: if you are on Windows, you'll need to install Poetry manually, and use:
cd python-qiskit poetry install
Once installed via one of the above methods, test your installation by running
pytest
in the python-qiskit
directory.
pytest
Usage
See the Jupyter notebooks.
Contributing
For general guidelines, see Contributing.
Building documentation
Documentation generation relies on Spinx. Automated builds are done by Read The Docs.
To build locally:
-
Ensure you have used one of the install options above.
-
Execute the make file from the docs directory:
If using Poetry:
cd docs poetry run make html
If using setuptools:
cd docs # Activate your virtual environment if required make html
The generated HTML will appear in the docs/_build/html
directory.
Credits
See Contributors.
License
See LICENSE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for qctrl_qiskit-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce21ee32d3447f0c7399f7463744bbcb4e20ad3c6ec753e330f52d4ada70dc00 |
|
MD5 | 74f05c6a897a2c903077404b3a39dac6 |
|
BLAKE2b-256 | 634f3ad9b54602fedfc99540d84f6d1a4114b85d4141a6284e9330cc4251603b |