Skip to main content

Quantum Hardware Library

Project description

Arline Quantum

Arline Quantum is an open-source library providing basic functionality for creating and manipulating quantum circuits. It also contains a list of mock quantum hardware.

Installation

$ pip3 install arline-quantum

Alternatively, Arline Quantum can be installed locally in the editable mode. Clone Arline Quantum repository, cd to the source directory:

$ git clone https://github.com/ArlineQ/arline_quantum.git
$ cd arline_quantum

We recommend to install Arline Quantum in the virtual environment.

$ virtualenv venv
$ source venv/bin/activate

If virtualenv is not installed on your machine, run

$ pip3 install virtualenv

Next in order to install the Arline Quantum platform execute:

$ pip3 install .

Alternatively, Arline Quantum can be installed in the editable mode:

$ pip3 install -e .

API documentation

API documentation is here documentation. To generate HTML API documentation, run below command:

$ cd docs/
$ make html

Running tests

To run unit-tests and check installed dependencies:

$ tox

Folder structure

arline_quantum
│
├── arline_quantum            # library
│   ├── gate_chain            # gate chain (circuit) class
│   ├── gate_sets             # collection of gate sets for quantum hardware
│   ├── gates                 # collection of quantum gates
│   ├── hardware              # collection of predefined mock hardware devices
│   ├── qasm_parser           # parser of .qasm circuits
│   └── qubit_connectivity    # list of hardware topologies and utils functions
│   
├── docs                      # documentation
│
└── test                      # tests
    ├── gate_chain            # tests for gate chain class
    ├── gates                 # tests for gates
    ├── hardware              # tests for quantum hardware
    ├── qasm_files            # .qasm files for gate_chain test
    └── qubit_connectivity    # tests for qubit connectivity class

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

arline-quantum-0.1.8.tar.gz (40.9 kB view hashes)

Uploaded Source

Built Distribution

arline_quantum-0.1.8-py3-none-any.whl (122.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page