# Aer - high performance quantum circuit simulation for Qiskit
[![License](https://img.shields.io/github/license/Qiskit/qiskit-aer.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)
[![Build](https://github.com/Qiskit/qiskit-aer/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/Qiskit/qiskit-aer/actions/workflows/build.yml)
[![Tests](https://github.com/Qiskit/qiskit-aer/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/Qiskit/qiskit-aer/actions/workflows/tests.yml)
[![](https://img.shields.io/github/release/Qiskit/qiskit-aer.svg?style=popout-square)](https://github.com/Qiskit/qiskit-aer/releases)
[![](https://img.shields.io/pypi/dm/qiskit-aer.svg?style=popout-square)](https://pypi.org/project/qiskit-aer/)
**Aer** is a high performance simulator for quantum circuits written in Qiskit, that includes realistic noise models.
## Installation
We encourage installing Aer via the pip tool (a python package manager):
```bash
pip install qiskit-aer
```
Pip will handle all dependencies automatically for us, and you will always install the latest (and well-tested) version.
To install from source, follow the instructions in the [contribution guidelines](CONTRIBUTING.md).
## Installing GPU support
In order to install and run the GPU supported simulators on Linux, you need CUDA® 11.2 or newer previously installed.
CUDA® itself would require a set of specific GPU drivers. Please follow CUDA® installation procedure in the NVIDIA® [web](https://www.nvidia.com/drivers).
If you want to install our GPU supported simulators, you have to install this other package:
```bash
pip install qiskit-aer-gpu
```
The package above is for CUDA® 12, so if your system has CUDA® 11 installed, install separate package:
```bash
pip install qiskit-aer-gpu-cu11
```
This will overwrite your current `qiskit-aer` package installation giving you
the same functionality found in the canonical `qiskit-aer` package, plus the
ability to run the GPU supported simulators: statevector, density matrix, and unitary.
**Note**: This package is only available on x86_64 Linux. For other platforms
that have CUDA support, you will have to build from source. You can refer to
the [contributing guide](CONTRIBUTING.md#building-with-gpu-support)
for instructions on doing this.
## Simulating your first Qiskit circuit with Aer
Now that you have Aer installed, you can start simulating quantum circuits with noise. Here is a basic example:
```
$ python
```
```python
import qiskit
from qiskit_aer import AerSimulator
from qiskit_ibm_runtime import QiskitRuntimeService
# Generate 3-qubit GHZ state
circ = qiskit.QuantumCircuit(3)
circ.h(0)
circ.cx(0, 1)
circ.cx(1, 2)
circ.measure_all()
# Construct an ideal simulator
aersim = AerSimulator()
# Perform an ideal simulation
result_ideal = aersim.run(circ).result()
counts_ideal = result_ideal.get_counts(0)
print('Counts(ideal):', counts_ideal)
# Counts(ideal): {'000': 493, '111': 531}
# Construct a simulator using a noise model
# from a real backend.
provider = QiskitRuntimeService()
backend = provider.get_backend("ibm_kyoto")
aersim_backend = AerSimulator.from_backend(backend)
# Perform noisy simulation
result_noise = aersim_backend.run(circ).result()
counts_noise = result_noise.get_counts(0)
print('Counts(noise):', counts_noise)
# Counts(noise): {'101': 16, '110': 48, '100': 7, '001': 31, '010': 7, '000': 464, '011': 15, '111': 436}
```
## Contribution Guidelines
If you'd like to contribute to Aer, please take a look at our
[contribution guidelines](CONTRIBUTING.md). This project adheres to Qiskit's [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
We use [GitHub issues](https://github.com/Qiskit/qiskit-aer/issues) for tracking requests and bugs. Please use our [slack](https://qiskit.slack.com) for discussion and simple questions. To join our Slack community use the [link](https://qiskit.slack.com/join/shared_invite/zt-fybmq791-hYRopcSH6YetxycNPXgv~A#/). For questions that are more suited for a forum, we use the Qiskit tag in the [Stack Exchange](https://quantumcomputing.stackexchange.com/questions/tagged/qiskit).
## Next Steps
Now you're set up and ready to check out some of the other examples from the [Aer documentation](https://qiskit.github.io/qiskit-aer/).
## Authors and Citation
Aer is the work of [many people](https://github.com/Qiskit/qiskit-aer/graphs/contributors) who contribute to the project at different levels.
If you use Qiskit, please cite as per the included [BibTeX file](https://github.com/Qiskit/qiskit/blob/main/CITATION.bib).
## License
[Apache License 2.0](LICENSE.txt)
Raw data
{
"_id": null,
"home_page": "https://github.com/Qiskit/qiskit-aer",
"name": "qiskit-aer-gpu-cu11",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "qiskit, simulator, quantum computing, backend",
"author": "AER Development Team",
"author_email": "qiskit@us.ibm.com",
"download_url": null,
"platform": null,
"description": "# Aer - high performance quantum circuit simulation for Qiskit\n\n[![License](https://img.shields.io/github/license/Qiskit/qiskit-aer.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)\n[![Build](https://github.com/Qiskit/qiskit-aer/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/Qiskit/qiskit-aer/actions/workflows/build.yml)\n[![Tests](https://github.com/Qiskit/qiskit-aer/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/Qiskit/qiskit-aer/actions/workflows/tests.yml)\n[![](https://img.shields.io/github/release/Qiskit/qiskit-aer.svg?style=popout-square)](https://github.com/Qiskit/qiskit-aer/releases)\n[![](https://img.shields.io/pypi/dm/qiskit-aer.svg?style=popout-square)](https://pypi.org/project/qiskit-aer/)\n\n**Aer** is a high performance simulator for quantum circuits written in Qiskit, that includes realistic noise models.\n\n## Installation\n\nWe encourage installing Aer via the pip tool (a python package manager):\n\n```bash\npip install qiskit-aer\n```\n\nPip will handle all dependencies automatically for us, and you will always install the latest (and well-tested) version.\n\nTo install from source, follow the instructions in the [contribution guidelines](CONTRIBUTING.md).\n\n## Installing GPU support\n\nIn order to install and run the GPU supported simulators on Linux, you need CUDA® 11.2 or newer previously installed.\nCUDA® itself would require a set of specific GPU drivers. Please follow CUDA® installation procedure in the NVIDIA® [web](https://www.nvidia.com/drivers).\n\nIf you want to install our GPU supported simulators, you have to install this other package:\n\n```bash\npip install qiskit-aer-gpu\n```\n\nThe package above is for CUDA® 12, so if your system has CUDA® 11 installed, install separate package:\n```bash\npip install qiskit-aer-gpu-cu11\n```\n\nThis will overwrite your current `qiskit-aer` package installation giving you\nthe same functionality found in the canonical `qiskit-aer` package, plus the\nability to run the GPU supported simulators: statevector, density matrix, and unitary.\n\n**Note**: This package is only available on x86_64 Linux. For other platforms\nthat have CUDA support, you will have to build from source. You can refer to\nthe [contributing guide](CONTRIBUTING.md#building-with-gpu-support)\nfor instructions on doing this.\n\n## Simulating your first Qiskit circuit with Aer\nNow that you have Aer installed, you can start simulating quantum circuits with noise. Here is a basic example:\n\n```\n$ python\n```\n\n```python\nimport qiskit\nfrom qiskit_aer import AerSimulator\nfrom qiskit_ibm_runtime import QiskitRuntimeService\n\n# Generate 3-qubit GHZ state\ncirc = qiskit.QuantumCircuit(3)\ncirc.h(0)\ncirc.cx(0, 1)\ncirc.cx(1, 2)\ncirc.measure_all()\n\n# Construct an ideal simulator\naersim = AerSimulator()\n\n# Perform an ideal simulation\nresult_ideal = aersim.run(circ).result()\ncounts_ideal = result_ideal.get_counts(0)\nprint('Counts(ideal):', counts_ideal)\n# Counts(ideal): {'000': 493, '111': 531}\n\n# Construct a simulator using a noise model\n# from a real backend.\nprovider = QiskitRuntimeService()\nbackend = provider.get_backend(\"ibm_kyoto\")\naersim_backend = AerSimulator.from_backend(backend)\n\n# Perform noisy simulation\nresult_noise = aersim_backend.run(circ).result()\ncounts_noise = result_noise.get_counts(0)\n\nprint('Counts(noise):', counts_noise)\n# Counts(noise): {'101': 16, '110': 48, '100': 7, '001': 31, '010': 7, '000': 464, '011': 15, '111': 436}\n```\n\n## Contribution Guidelines\n\nIf you'd like to contribute to Aer, please take a look at our\n[contribution guidelines](CONTRIBUTING.md). This project adheres to Qiskit's [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.\n\nWe use [GitHub issues](https://github.com/Qiskit/qiskit-aer/issues) for tracking requests and bugs. Please use our [slack](https://qiskit.slack.com) for discussion and simple questions. To join our Slack community use the [link](https://qiskit.slack.com/join/shared_invite/zt-fybmq791-hYRopcSH6YetxycNPXgv~A#/). For questions that are more suited for a forum, we use the Qiskit tag in the [Stack Exchange](https://quantumcomputing.stackexchange.com/questions/tagged/qiskit).\n\n## Next Steps\n\nNow you're set up and ready to check out some of the other examples from the [Aer documentation](https://qiskit.github.io/qiskit-aer/).\n\n## Authors and Citation\n\nAer is the work of [many people](https://github.com/Qiskit/qiskit-aer/graphs/contributors) who contribute to the project at different levels.\nIf you use Qiskit, please cite as per the included [BibTeX file](https://github.com/Qiskit/qiskit/blob/main/CITATION.bib).\n\n## License\n\n[Apache License 2.0](LICENSE.txt)\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Aer - High performance simulators for Qiskit",
"version": "0.14.0.1",
"project_urls": {
"Homepage": "https://github.com/Qiskit/qiskit-aer"
},
"split_keywords": [
"qiskit",
" simulator",
" quantum computing",
" backend"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b907f1f16ef17f685caf6c08d5271bd126c951b3edf5e054efec3c3971c917cb",
"md5": "bc3b4b6a5b7492bd6950dde7e283fd38",
"sha256": "b0860ea4f3a4327e0aeed7fa98f357286a27e99959f08fc35fc06d47c8519c10"
},
"downloads": -1,
"filename": "qiskit_aer_gpu_cu11-0.14.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "bc3b4b6a5b7492bd6950dde7e283fd38",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 18029844,
"upload_time": "2024-04-02T05:55:30",
"upload_time_iso_8601": "2024-04-02T05:55:30.508360Z",
"url": "https://files.pythonhosted.org/packages/b9/07/f1f16ef17f685caf6c08d5271bd126c951b3edf5e054efec3c3971c917cb/qiskit_aer_gpu_cu11-0.14.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b4a3f3a9e88293cd8329f47c15bdd92fb3b8362a7b1cb3e8b1b70abc7cbc6714",
"md5": "5c3f8b2614d188a8ba6b45c28e4848d7",
"sha256": "0f2f547d0607757ea70e83507b018353b1f0f4c2eb8f92dddace9c614a71c0cb"
},
"downloads": -1,
"filename": "qiskit_aer_gpu_cu11-0.14.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "5c3f8b2614d188a8ba6b45c28e4848d7",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7",
"size": 18032741,
"upload_time": "2024-04-02T05:55:33",
"upload_time_iso_8601": "2024-04-02T05:55:33.447360Z",
"url": "https://files.pythonhosted.org/packages/b4/a3/f3a9e88293cd8329f47c15bdd92fb3b8362a7b1cb3e8b1b70abc7cbc6714/qiskit_aer_gpu_cu11-0.14.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b60cfed0ced2946a09deda5202463d58ba2fd46252a8db1f5e0adbe04bea643f",
"md5": "1487beaf7521ca41761527afd614c117",
"sha256": "e37941af54e39504d2fe6716a2cb08effd6add79e3858069def9b339c30aa8c6"
},
"downloads": -1,
"filename": "qiskit_aer_gpu_cu11-0.14.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "1487beaf7521ca41761527afd614c117",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.7",
"size": 18033242,
"upload_time": "2024-04-02T05:55:35",
"upload_time_iso_8601": "2024-04-02T05:55:35.922239Z",
"url": "https://files.pythonhosted.org/packages/b6/0c/fed0ced2946a09deda5202463d58ba2fd46252a8db1f5e0adbe04bea643f/qiskit_aer_gpu_cu11-0.14.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "71b36c75f3ba37693c38c9de99fe37c6e908907df7dbb74f224d1fd0932adb0c",
"md5": "da17fda31f926fe294077f3f64b2417b",
"sha256": "c2432d1f86da1c1d38cb842e314dc35aaeaeffaae14276bb6e079736fb8c2ffc"
},
"downloads": -1,
"filename": "qiskit_aer_gpu_cu11-0.14.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "da17fda31f926fe294077f3f64b2417b",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7",
"size": 18026821,
"upload_time": "2024-04-02T05:55:38",
"upload_time_iso_8601": "2024-04-02T05:55:38.814980Z",
"url": "https://files.pythonhosted.org/packages/71/b3/6c75f3ba37693c38c9de99fe37c6e908907df7dbb74f224d1fd0932adb0c/qiskit_aer_gpu_cu11-0.14.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6327ddb6d50c9902bc58728dc1d2917ef9dbcb73bb3e277c8ca4dde6180ee0d4",
"md5": "c73b7de25c56de1bfc4fa6cb4f67be60",
"sha256": "0c99829451c57a8c8b90e95b34de0dae472ba12430733f6b76c00fda79f3b991"
},
"downloads": -1,
"filename": "qiskit_aer_gpu_cu11-0.14.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "c73b7de25c56de1bfc4fa6cb4f67be60",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.7",
"size": 18031458,
"upload_time": "2024-04-02T05:55:41",
"upload_time_iso_8601": "2024-04-02T05:55:41.431766Z",
"url": "https://files.pythonhosted.org/packages/63/27/ddb6d50c9902bc58728dc1d2917ef9dbcb73bb3e277c8ca4dde6180ee0d4/qiskit_aer_gpu_cu11-0.14.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 05:55:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Qiskit",
"github_project": "qiskit-aer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "qiskit-aer-gpu-cu11"
}