"Orquestra's library with basic quantum operations"
Project description
orquestra-quantum
What is it?
orquestra-quantum
is a library with core functionalities for quantum computing developed by Zapata for our Orquestra platform.
orquestra-quantum
provides:
- core functionalities required to run experiments, such as the
Circuit
class. - interfaces for implementing other Orquestra modules, such as quantum backends.
- basic data structures and functions for quantum computing.
Installation
Even though it's intended to be used with Orquestra, orquestra-quantum
can be also used as a standalone Python module.
To install it, you just need to run pip install .
from the main directory.
Usage
Here's an example of how to use methods from orquestra-quantum
to run a circuit locally. The program runs a circuit with a single Hadamard gate 100 times and returns the results:
from orquestra.quantum.circuits import H, Circuit
from orquestra.quantum.symbolic_simulator import SymbolicSimulator
def orquestra_quantum_example_function()
circ = Circuit([H(0)])
sim = SymbolicSimulator()
nsamples = 100
measurements = sim.run_circuit_and_measure(circ, nsamples)
return measurements.get_counts()
Development and Contribution
To install the development version, run pip install -e '.[dev]'
from the main directory. (if using MacOS, you will need single quotes around the []. If using windows, or Linux, you might not need the quotes).
We use Google-style docstring format. If you'd like to specify types please use PEP 484 type hints instead adding them to docstrings.
There are codestyle-related Github Actions running for PRs.
- If you'd like to report a bug/issue please create a new issue in this repository.
- If you'd like to contribute, please create a pull request to
main
.
Running tests
Unit tests for this project can be run using make coverage
command from the main directory.
Alternatively you can also run pytest .
.
Style
We are using automatic tools for style and type checking. In order to make sure the code is compliant with them please run: make style
from the main directory (this requires dev
dependencies).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file orquestra-quantum-0.12.0.tar.gz
.
File metadata
- Download URL: orquestra-quantum-0.12.0.tar.gz
- Upload date:
- Size: 145.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 492a5859c87549530d6242ec9a1a5f1b25c173d5e946b3e7555860dd5b351e3c |
|
MD5 | c947f542eb5282ab19590948f8274846 |
|
BLAKE2b-256 | ae04b4fc3c748b2a1382ed7d58b1da38821993b51a43c96c466c3a61ebbecd17 |