Metadata-Version: 2.1
Name: icquantum
Version: 0.0.2
Summary: Support tooling for Quantum Computing simulations.
Author-email: "Ben Collingwood, Irish Centre for High End Computing" <benjamin.collingwood@ichec.ie>
Project-URL: Repository, https://git.ichec.ie/performance/toolshed/icquantum
Project-URL: Homepage, https://git.ichec.ie/performance/toolshed/icquantum
Keywords: Quantum Computing,Workflow,HPC
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Distributed Computing
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: icflow==0.0.13
Requires-Dist: qiskit-aer
Requires-Dist: mqt.bench
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-sugar; extra == "test"
Requires-Dist: black; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: pylint; extra == "test"
Requires-Dist: mypy; extra == "test"

# icquantum

This project has tools for building and running Quantum Circuit simulations. It is used in some ICHEC projects and [demos](https://git.ichec.ie/performance/recipes/quantum).

## Installing ##

The package is available on PyPI, you can install it with:

``` shell
pip install icquantum
```

## Features ##

### Benchmarking ###

You can run a named quantum circuit from a benchmark as follows:

``` shell
icquantum benchmark --circuit sample
```

At the moment the library has a single built-in circuit `sample` and the [MQT Bench](https://github.com/cda-tum/mqt-bench) benchmark. Circuits for the later are namespaced with `mqtbench:`, so you can launch one with:

``` shell
icquantum benchmark --circuit mqtbench:dj
```

for example. The are many other command line arguments allowing control over number of circuits and iterations run and Qiskit runtime settings. They can be seen with:

``` shell
icquantum benchmark --help
```

## License ##

This software is Copyright ICHEC 2024 and can be re-used under the terms of the GPL v3+. See the included `LICENSE` file for details.
