| Name | qcircpy JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A package for Python Quantum Circuit Simulation and Benchmarking |
| upload_time | 2024-06-20 14:50:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | BSD 2-Clause License Copyright (c) 2024, Jake Lu Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
quantum
circuit
simulation
benchmarking
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
numpy
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# QCircPy
QCircPy is a Quantum Computer Simulation and Benchmarking package on Python with GPU and CPU flexibility and performance. It allows the user to benchmark and run simple Quantum Circuits on a GPU or CPU with `numpy` and `cupy`.
This project is for educational purposes.
## Installation
### Prerequisites
QCircPy requires `numpy`, which is installed automatically, and `cupy`, which the user should install manually based on their CUDA version.
For users using CUDA 11.x:
```cmd
pip install cupy-cuda11x
```
or:
```cmd
py -m pip install cupy-cuda11x
```
For users using CUDA 12.x:
```cmd
pip install cupy-cuda12x
```
or:
```cmd
py - m pip install cupy-cuda12x
```
Then, finally:
### Installation
```cmd
pip install qcircpy
```
or:
```cmd
py -m pip install qcircpy
```
## Usage
It is recommended to use the `engine` subpackage as an interface to QCircPy's functionalities.
```py
import qcircpy.engine as qp
```
Detailed usage can be found in [USAGE.md](USAGE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "qcircpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "quantum, circuit, simulation, benchmarking",
"author": null,
"author_email": "Jake Lu <jylu1205@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/37/b4/3f987e472ef1125ec348a74d4b2aea963f47c5f6d86509aea29dca1470be/qcircpy-0.1.1.tar.gz",
"platform": null,
"description": "# QCircPy\r\n\r\nQCircPy is a Quantum Computer Simulation and Benchmarking package on Python with GPU and CPU flexibility and performance. It allows the user to benchmark and run simple Quantum Circuits on a GPU or CPU with `numpy` and `cupy`.\r\n\r\nThis project is for educational purposes.\r\n\r\n\r\n\r\n\r\n## Installation\r\n\r\n### Prerequisites\r\n\r\nQCircPy requires `numpy`, which is installed automatically, and `cupy`, which the user should install manually based on their CUDA version.\r\n\r\nFor users using CUDA 11.x:\r\n\r\n```cmd\r\npip install cupy-cuda11x\r\n```\r\n\r\nor:\r\n\r\n```cmd\r\npy -m pip install cupy-cuda11x\r\n```\r\n\r\nFor users using CUDA 12.x:\r\n\r\n```cmd\r\npip install cupy-cuda12x\r\n```\r\n\r\nor:\r\n\r\n```cmd\r\npy - m pip install cupy-cuda12x\r\n```\r\n\r\nThen, finally:\r\n\r\n### Installation\r\n\r\n```cmd\r\npip install qcircpy\r\n```\r\n\r\nor:\r\n\r\n```cmd\r\npy -m pip install qcircpy\r\n```\r\n\r\n\r\n\r\n## Usage\r\n\r\nIt is recommended to use the `engine` subpackage as an interface to QCircPy's functionalities. \r\n\r\n```py\r\nimport qcircpy.engine as qp\r\n```\r\n\r\nDetailed usage can be found in [USAGE.md](USAGE.md)\r\n",
"bugtrack_url": null,
"license": "BSD 2-Clause License Copyright (c) 2024, Jake Lu Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "A package for Python Quantum Circuit Simulation and Benchmarking",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/Deftioon/qcircpy",
"Issues": "https://github.com/Deftioon/qcircpy/issues"
},
"split_keywords": [
"quantum",
" circuit",
" simulation",
" benchmarking"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57e4f1c10983cb507bbc4ffd09b229014557e28d8bcc697f852010f7aefbcbff",
"md5": "9ec002dcdf91c31631762a557415128f",
"sha256": "a6e2d3243b0c6058cb0900a61687b14a81882e5c8208c4e65e9fbde3ef925eee"
},
"downloads": -1,
"filename": "qcircpy-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ec002dcdf91c31631762a557415128f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 10273,
"upload_time": "2024-06-20T14:50:15",
"upload_time_iso_8601": "2024-06-20T14:50:15.952845Z",
"url": "https://files.pythonhosted.org/packages/57/e4/f1c10983cb507bbc4ffd09b229014557e28d8bcc697f852010f7aefbcbff/qcircpy-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "37b43f987e472ef1125ec348a74d4b2aea963f47c5f6d86509aea29dca1470be",
"md5": "edd3318e99899e5f574d4cf665716953",
"sha256": "a60571176cfe70fed87bf4e586c80104707f6d0dcaa72224ccc0628249c6168b"
},
"downloads": -1,
"filename": "qcircpy-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "edd3318e99899e5f574d4cf665716953",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 9393,
"upload_time": "2024-06-20T14:50:18",
"upload_time_iso_8601": "2024-06-20T14:50:18.542219Z",
"url": "https://files.pythonhosted.org/packages/37/b4/3f987e472ef1125ec348a74d4b2aea963f47c5f6d86509aea29dca1470be/qcircpy-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-20 14:50:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Deftioon",
"github_project": "qcircpy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "numpy",
"specs": []
}
],
"lcname": "qcircpy"
}
