# qiskit-qir
Qiskit to QIR translator.
## Example
```python
from qiskit import QuantumCircuit
from qiskit_qir import to_qir_module
circuit = QuantumCircuit(3, 3, name="my-circuit")
circuit.h(0)
circuit.cx(0, 1)
circuit.cx(1, 2)
circuit.measure([0,1,2], [0, 1, 2])
module, entry_points = to_qir_module(circuit)
bitcode = module.bitcode
ir = str(module)
```
## Installation
Install `qiskit-qir` with `pip`:
```bash
pip install qiskit-qir
```
> Note: this will automatically install PyQIR if needed.
## Development
### Install from source
To install the package from source, clone the repo onto your machine, browse to the root directory and run
```bash
pip install -e .
```
### Tests
First, install the development dependencies using
```bash
pip install -r requirements_dev.txt
```
To run the tests in your local environment, run
```bash
make test
```
To run the tests in virtual environments on supported Python versions, run
```bash
make test-all
```
### Docs
To build the docs using Sphinx, run
```bash
make docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/microsoft/qiskit-qir",
"name": "qiskit-qir",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Microsoft",
"author_email": "que-contacts@microsoft.com",
"download_url": "https://files.pythonhosted.org/packages/95/4f/242d1fe01ff971895689c7fe9924e0f886df29b0bbf4f6334b013dee6ad4/qiskit-qir-0.5.0.tar.gz",
"platform": null,
"description": "# qiskit-qir\n\nQiskit to QIR translator.\n\n## Example\n\n```python\nfrom qiskit import QuantumCircuit\nfrom qiskit_qir import to_qir_module\n\ncircuit = QuantumCircuit(3, 3, name=\"my-circuit\")\ncircuit.h(0)\ncircuit.cx(0, 1)\ncircuit.cx(1, 2)\ncircuit.measure([0,1,2], [0, 1, 2])\n\nmodule, entry_points = to_qir_module(circuit)\nbitcode = module.bitcode\nir = str(module)\n```\n\n## Installation\n\nInstall `qiskit-qir` with `pip`:\n\n```bash\npip install qiskit-qir\n```\n> Note: this will automatically install PyQIR if needed.\n\n## Development\n\n### Install from source\n\nTo install the package from source, clone the repo onto your machine, browse to the root directory and run\n\n```bash\npip install -e .\n```\n\n### Tests\n\nFirst, install the development dependencies using\n\n```bash\npip install -r requirements_dev.txt\n```\n\nTo run the tests in your local environment, run\n\n```bash\nmake test\n```\n\nTo run the tests in virtual environments on supported Python versions, run\n\n```bash\nmake test-all\n```\n\n### Docs\n\nTo build the docs using Sphinx, run\n\n```bash\nmake docs\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Qiskit to QIR translator",
"version": "0.5.0",
"project_urls": {
"Bug Tracker": "https://github.com/microsoft/qiskit-qir",
"Homepage": "https://github.com/microsoft/qiskit-qir"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ebad359059ba1169a106fa9f0bfdd7068423ead0490aa313fb2361cb03116dde",
"md5": "8466628ec1440326c67da7d26ff1482e",
"sha256": "646c924919d24562d4640973f0284d32e9e2e8c63b6352b12e98f1bce89b1e8e"
},
"downloads": -1,
"filename": "qiskit_qir-0.5.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8466628ec1440326c67da7d26ff1482e",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 19806,
"upload_time": "2024-03-05T20:47:56",
"upload_time_iso_8601": "2024-03-05T20:47:56.953758Z",
"url": "https://files.pythonhosted.org/packages/eb/ad/359059ba1169a106fa9f0bfdd7068423ead0490aa313fb2361cb03116dde/qiskit_qir-0.5.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "954f242d1fe01ff971895689c7fe9924e0f886df29b0bbf4f6334b013dee6ad4",
"md5": "b0f71dfb3ba0cc7a56ebc839643dfcef",
"sha256": "5635837234974fdf6f1f6863231493f1fcdd571dc5283b480fe45ef69c9c86fd"
},
"downloads": -1,
"filename": "qiskit-qir-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "b0f71dfb3ba0cc7a56ebc839643dfcef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 33353,
"upload_time": "2024-03-05T20:48:00",
"upload_time_iso_8601": "2024-03-05T20:48:00.087776Z",
"url": "https://files.pythonhosted.org/packages/95/4f/242d1fe01ff971895689c7fe9924e0f886df29b0bbf4f6334b013dee6ad4/qiskit-qir-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 20:48:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "microsoft",
"github_project": "qiskit-qir",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "qiskit-qir"
}
JSON
