<p align="center">
<img src="piquasso_logo.svg" alt="Piquasso logo"/>
</p>
## A Python library for designing and simulating photonic quantum computers
Piquasso is a simulator for photonic quantum computations.
> This is a research project, bugs can be expected. If you encounter any, please report
> it in the [Issues page](https://github.com/Budapest-Quantum-Computing-Group/piquasso/issues).
## Installation
Piquasso and its dependencies can be installed via pip:
```
pip install piquasso
```
If you wish to, you can also install
[piquassoboost](https://github.com/Budapest-Quantum-Computing-Group/piquassoboost) for
performance improvement.
## Documentation
The documentation is avaliable at [docs.piquasso.com](https://docs.piquasso.com/).
## How to contribute?
We welcome people who want to make contributions to Piquasso, be it big or small! If you
are considering larger contributions to the source code, please contact us first.
We also appreciate bug reports, suggestions, or any kind of idea regarding Piquasso.
## Development guide
The `eigen3` C++ library needs to be installed for the `thewalrus` (dependency of
`strawberryfields`).
On Ubuntu/Debian you can install it with
```
sudo apt-get install libeigen3-dev
```
Now, to install development dependencies, use:
```
pip install -r requirements.txt
```
## Testing
Tests and additional checks can be run using `tox`. After installation, run the
following command:
```
tox -e py311
```
Alternatively, you can run only the tests using `pytest`. After installation, run the
following command:
```
pytest tests
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Budapest-Quantum-Computing-Group/piquasso",
"name": "piquasso",
"maintainer": "Budapest Quantum Computing Group",
"docs_url": null,
"requires_python": "",
"maintainer_email": "kolarovszki@inf.elte.hu",
"keywords": "python,piquasso",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/1f/9e/9fb68833053f9eac0487af4ebdfbabb557b73e6a0ff9850d03e39331f7bb/piquasso-4.0.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"piquasso_logo.svg\" alt=\"Piquasso logo\"/>\n</p>\n\n\n\n\n\n\n## A Python library for designing and simulating photonic quantum computers\n\nPiquasso is a simulator for photonic quantum computations.\n\n> This is a research project, bugs can be expected. If you encounter any, please report\n> it in the [Issues page](https://github.com/Budapest-Quantum-Computing-Group/piquasso/issues).\n\n## Installation\n\nPiquasso and its dependencies can be installed via pip:\n\n```\npip install piquasso\n```\n\nIf you wish to, you can also install\n[piquassoboost](https://github.com/Budapest-Quantum-Computing-Group/piquassoboost) for\nperformance improvement.\n\n## Documentation\n\nThe documentation is avaliable at [docs.piquasso.com](https://docs.piquasso.com/).\n\n## How to contribute?\n\nWe welcome people who want to make contributions to Piquasso, be it big or small! If you\nare considering larger contributions to the source code, please contact us first.\n\nWe also appreciate bug reports, suggestions, or any kind of idea regarding Piquasso.\n\n## Development guide\n\nThe `eigen3` C++ library needs to be installed for the `thewalrus` (dependency of\n`strawberryfields`).\n\nOn Ubuntu/Debian you can install it with\n\n```\nsudo apt-get install libeigen3-dev\n```\n\nNow, to install development dependencies, use:\n\n```\npip install -r requirements.txt\n```\n\n## Testing\n\nTests and additional checks can be run using `tox`. After installation, run the\nfollowing command:\n\n```\ntox -e py311\n```\n\nAlternatively, you can run only the tests using `pytest`. After installation, run the\nfollowing command:\n\n```\npytest tests\n```\n",
"bugtrack_url": null,
"license": "Apache License 2.0.",
"summary": "",
"version": "4.0.0",
"project_urls": {
"Homepage": "https://github.com/Budapest-Quantum-Computing-Group/piquasso"
},
"split_keywords": [
"python",
"piquasso"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5101508c3cf3a2951a5589faff596777a75ec3b5625cf0fee734254db3c92ee1",
"md5": "021731af99eacad167a7e40ba4fa2fde",
"sha256": "4f66bdf4534b2534f975adaf14c78046c55174f32d362e48e22541e372c6f569"
},
"downloads": -1,
"filename": "piquasso-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "021731af99eacad167a7e40ba4fa2fde",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 124839,
"upload_time": "2024-02-29T15:30:28",
"upload_time_iso_8601": "2024-02-29T15:30:28.051513Z",
"url": "https://files.pythonhosted.org/packages/51/01/508c3cf3a2951a5589faff596777a75ec3b5625cf0fee734254db3c92ee1/piquasso-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f9e9fb68833053f9eac0487af4ebdfbabb557b73e6a0ff9850d03e39331f7bb",
"md5": "7c11736a1bc359f0a658189a5e40c6b5",
"sha256": "eabffeddd3f47cc51c7848a9c311c94d2384164f786a6ccd9f0c375b8cb9b4ce"
},
"downloads": -1,
"filename": "piquasso-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "7c11736a1bc359f0a658189a5e40c6b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 348570,
"upload_time": "2024-02-29T15:30:30",
"upload_time_iso_8601": "2024-02-29T15:30:30.721982Z",
"url": "https://files.pythonhosted.org/packages/1f/9e/9fb68833053f9eac0487af4ebdfbabb557b73e6a0ff9850d03e39331f7bb/piquasso-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 15:30:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Budapest-Quantum-Computing-Group",
"github_project": "piquasso",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "piquasso"
}
JSON
