# pyqrack
[](https://pepy.tech/project/pyqrack) [](https://pepy.tech/project/pyqrack)
Pure Python bindings for the pure C++11/OpenCL Qrack quantum computer simulator library
(**PyQrack** is just pure Qrack.)
To use this package, it's helpful to be familiar with [vm6502q/qrack](https://github.com/vm6502q/qrack). Users gain **much** more control over options by building **vm6502q/qrack** and [vm6502q/pyqrack](https://github.com/vm6502q/pyqrack) from source. For advanced users, building from source is the intended primary method of **PyQrack** package distribution and use.
Import and instantiate [`QrackSimulator`](https://github.com/vm6502q/pyqrack/blob/main/pyqrack/qrack_simulator.py) instances. This simulator can perform arbitrary single qubit and controlled-single-qubit gates, as well as other specific gates like `SWAP`.
Any 2x2 bit operator matrix is represented by a list of 4 `complex` floating point numbers, in [**row-major order**](https://en.wikipedia.org/wiki/Row-_and_column-major_order).
Single and array "`b`" parameters represent [**Pauli operator bases**](https://en.wikipedia.org/wiki/Pauli_matrices). They are specified according to the enumeration of the [`Pauli`](https://github.com/vm6502q/pyqrack/blob/main/pyqrack/pauli.py) class.
`MC[x]` and `MAC[x]` methods are controlled single bit gates, with as many control qubits as you specify via Python list `c` argument. `MCX` is multiply-controlled Pauli X, and `MACX` is "anti-"controlled Pauli X, i.e. "anti-control" activates the gate if all control bits are specifically **off**, as opposed to **on**.
The package installation directory contains a `qrack_cl_precompile` folder with executables for supported platforms, to compile OpenCL kernels once, beforehand, avoiding the need to recompile "just-in-time" every time that you load this package in a Python interpreter. If you no longer want to use precompiled kernels, or if precompilation fails, just delete the `~/.qrack` directory, or the equivalent `.qrack` sub-directory in the user home folder of your operating system.
To load the required **vm6502q/qrack** libraries from a different location, set the `PYQRACK_SHARED_LIB_PATH` environment variable. If an absolute path is set for this variable, it will be treated as an absolute path. If a relative path is used, the **pyqrack** package `qrack_system` directory is the root.
PyQrack v0.4.6 adds experimental support for [PyZX](https://github.com/Quantomatic/pyzx) `Circuit` definitions as an intermediate representation for `QrackSimulator`. To try this, load a `Circuit` in PyZX, (use that module to optimize your circuit, as you like,) and create a `QrackSimulator()` instance using the `pyzxCircuit` named argument of the constructor, like so:
```python
sim = QrackSimulator(pyzxCircuit=c)
```
where `c` is a PyZX circuit object. The circuit will automatically be simulated in the constructed `QrackSimulator` instance. This also allows loading from QASM and other intermediate representations supported by PyZX.
See [https://pyqrack.readthedocs.io/en/latest/](https://pyqrack.readthedocs.io/en/latest/) for an API reference.
Please feel welcome to open an issue, if you'd like help. 😃
**Special thanks go to Zeeshan Ahmed, for bug fixes and design suggestions, Ashish Panigrahi, for documentation and design suggestions, WingCode, for documentation, and to the broader community of Qrack contributors, for years of happy Qracking! You rock!**
Raw data
{
"_id": null,
"home_page": "https://github.com/vm6502q/pyqrack",
"name": "pyqrack-cuda",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pyqrack qrack simulator quantum gpu",
"author": "Daniel Strano",
"author_email": "dan@unitary.fund",
"download_url": "https://files.pythonhosted.org/packages/49/50/baf036d16ccf108c6685eafbde25ee5796196aed6ba0a50a72ea83a2a21a/pyqrack-cuda-1.27.0.tar.gz",
"platform": null,
"description": "# pyqrack\n[](https://pepy.tech/project/pyqrack) [](https://pepy.tech/project/pyqrack)\n\nPure Python bindings for the pure C++11/OpenCL Qrack quantum computer simulator library\n\n(**PyQrack** is just pure Qrack.)\n\nTo use this package, it's helpful to be familiar with [vm6502q/qrack](https://github.com/vm6502q/qrack). Users gain **much** more control over options by building **vm6502q/qrack** and [vm6502q/pyqrack](https://github.com/vm6502q/pyqrack) from source. For advanced users, building from source is the intended primary method of **PyQrack** package distribution and use.\n\nImport and instantiate [`QrackSimulator`](https://github.com/vm6502q/pyqrack/blob/main/pyqrack/qrack_simulator.py) instances. This simulator can perform arbitrary single qubit and controlled-single-qubit gates, as well as other specific gates like `SWAP`.\n\nAny 2x2 bit operator matrix is represented by a list of 4 `complex` floating point numbers, in [**row-major order**](https://en.wikipedia.org/wiki/Row-_and_column-major_order).\n\nSingle and array \"`b`\" parameters represent [**Pauli operator bases**](https://en.wikipedia.org/wiki/Pauli_matrices). They are specified according to the enumeration of the [`Pauli`](https://github.com/vm6502q/pyqrack/blob/main/pyqrack/pauli.py) class.\n\n`MC[x]` and `MAC[x]` methods are controlled single bit gates, with as many control qubits as you specify via Python list `c` argument. `MCX` is multiply-controlled Pauli X, and `MACX` is \"anti-\"controlled Pauli X, i.e. \"anti-control\" activates the gate if all control bits are specifically **off**, as opposed to **on**.\n\nThe package installation directory contains a `qrack_cl_precompile` folder with executables for supported platforms, to compile OpenCL kernels once, beforehand, avoiding the need to recompile \"just-in-time\" every time that you load this package in a Python interpreter. If you no longer want to use precompiled kernels, or if precompilation fails, just delete the `~/.qrack` directory, or the equivalent `.qrack` sub-directory in the user home folder of your operating system.\n\nTo load the required **vm6502q/qrack** libraries from a different location, set the `PYQRACK_SHARED_LIB_PATH` environment variable. If an absolute path is set for this variable, it will be treated as an absolute path. If a relative path is used, the **pyqrack** package `qrack_system` directory is the root.\n\nPyQrack v0.4.6 adds experimental support for [PyZX](https://github.com/Quantomatic/pyzx) `Circuit` definitions as an intermediate representation for `QrackSimulator`. To try this, load a `Circuit` in PyZX, (use that module to optimize your circuit, as you like,) and create a `QrackSimulator()` instance using the `pyzxCircuit` named argument of the constructor, like so:\n\n```python\nsim = QrackSimulator(pyzxCircuit=c)\n```\n\nwhere `c` is a PyZX circuit object. The circuit will automatically be simulated in the constructed `QrackSimulator` instance. This also allows loading from QASM and other intermediate representations supported by PyZX.\n\nSee [https://pyqrack.readthedocs.io/en/latest/](https://pyqrack.readthedocs.io/en/latest/) for an API reference.\n\nPlease feel welcome to open an issue, if you'd like help. \ud83d\ude03\n\n**Special thanks go to Zeeshan Ahmed, for bug fixes and design suggestions, Ashish Panigrahi, for documentation and design suggestions, WingCode, for documentation, and to the broader community of Qrack contributors, for years of happy Qracking! You rock!**\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "pyqrack - Pure Python vm6502q/qrack Wrapper",
"version": "1.27.0",
"project_urls": {
"Homepage": "https://github.com/vm6502q/pyqrack"
},
"split_keywords": [
"pyqrack",
"qrack",
"simulator",
"quantum",
"gpu"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b8220c346386b331dba6d0091696233adc8b1036a2b6731bd23d4a4774fd32b",
"md5": "e4d21c759dd163c469d7aeef1a9c7cc8",
"sha256": "f5b01c61ba4a79948f216d8a9b14d8333841edc7680af766d46a3f457b96840f"
},
"downloads": -1,
"filename": "pyqrack_cuda-1.27.0-py3-none-manylinux_2_35_x86_64.whl",
"has_sig": false,
"md5_digest": "e4d21c759dd163c469d7aeef1a9c7cc8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6076830,
"upload_time": "2024-02-27T13:18:49",
"upload_time_iso_8601": "2024-02-27T13:18:49.193435Z",
"url": "https://files.pythonhosted.org/packages/9b/82/20c346386b331dba6d0091696233adc8b1036a2b6731bd23d4a4774fd32b/pyqrack_cuda-1.27.0-py3-none-manylinux_2_35_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4950baf036d16ccf108c6685eafbde25ee5796196aed6ba0a50a72ea83a2a21a",
"md5": "71f78937e784adde4874bcdc75ab39cf",
"sha256": "9d023f916e9abdd446cea9fd7e58d96924248f65f568d8e09bbe0540123ff055"
},
"downloads": -1,
"filename": "pyqrack-cuda-1.27.0.tar.gz",
"has_sig": false,
"md5_digest": "71f78937e784adde4874bcdc75ab39cf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6007370,
"upload_time": "2024-02-27T13:18:53",
"upload_time_iso_8601": "2024-02-27T13:18:53.705840Z",
"url": "https://files.pythonhosted.org/packages/49/50/baf036d16ccf108c6685eafbde25ee5796196aed6ba0a50a72ea83a2a21a/pyqrack-cuda-1.27.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-27 13:18:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vm6502q",
"github_project": "pyqrack",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyqrack-cuda"
}
JSON
