| Name | pytket-pysimplex JSON |
| Version |
0.15.0
JSON |
| download |
| home_page | None |
| Summary | Extension for pytket, providing access to the pysimplex Clifford simulator |
| upload_time | 2024-04-17 14:47:35 |
| maintainer | None |
| docs_url | None |
| author | TKET development team |
| requires_python | ~=3.10 |
| license | Apache 2 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pytket-pysimplex
[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a python module for interfacing
with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.
`pytket-pysimplex` is an extension to `pytket` that allows `pytket` circuits to
be simulated using pysimplex.
## Getting started
`pytket-pysimplex` is available for Python 3.10, 3.11 and 3.12, on Linux, MacOS
and Windows. To install, run:
```shell
pip install pytket-pysimplex
```
This will install `pytket` if it isn't already installed, and add new classes
and methods into the `pytket.extensions` namespace.
## Bugs, support and feature requests
Please file bugs and feature requests on the Github
[issue tracker](https://github.com/CQCL/pytket-pysimplex/issues).
There is also a Slack channel for discussion and support. Click [here](https://tketusers.slack.com/join/shared_invite/zt-18qmsamj9-UqQFVdkRzxnXCcKtcarLRA#/shared-invite/email) to join.
## Development
To install an extension in editable mode, simply change to its subdirectory
within the `modules` directory, and run:
```shell
pip install -e .
```
## Contributing
Pull requests are welcome. To make a PR, first fork the repo, make your proposed
changes on the `develop` branch, and open a PR from your fork. If it passes
tests and is accepted after review, it will be merged in.
### Code style
#### Formatting
All code should be formatted using
[black](https://black.readthedocs.io/en/stable/), with default options. This is
checked on the CI. The CI is currently using version 22.3.
#### Type annotation
On the CI, [mypy](https://mypy.readthedocs.io/en/stable/) is used as a static
type checker and all submissions must pass its checks. You should therefore run
`mypy` locally on any changed files before submitting a PR. Because of the way
extension modules embed themselves into the `pytket` namespace this is a little
complicated, but it should be sufficient to run the script `modules/mypy-check`
(passing as a single argument the root directory of the module to test). The
script requires `mypy` 0.800 or above.
#### Linting
We use [pylint](https://pypi.org/project/pylint/) on the CI to check compliance
with a set of style requirements (listed in `.pylintrc`). You should run
`pylint` over any changed files before submitting a PR, to catch any issues.
### Tests
To run the tests for a module:
1. `cd` into that module's `tests` directory;
2. ensure you have installed `pytest`, `hypothesis`, and any modules listed in
the `test-requirements.txt` file (all via `pip`);
3. run `pytest`.
When adding a new feature, please add a test for it. When fixing a bug, please
add a test that demonstrates the fix.
Raw data
{
"_id": null,
"home_page": null,
"name": "pytket-pysimplex",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.10",
"maintainer_email": null,
"keywords": null,
"author": "TKET development team",
"author_email": "tket-support@cambridgequantum.com",
"download_url": null,
"platform": null,
"description": "# pytket-pysimplex\r\n\r\n[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a python module for interfacing\r\nwith tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.\r\n\r\n`pytket-pysimplex` is an extension to `pytket` that allows `pytket` circuits to\r\nbe simulated using pysimplex.\r\n\r\n## Getting started\r\n\r\n`pytket-pysimplex` is available for Python 3.10, 3.11 and 3.12, on Linux, MacOS\r\nand Windows. To install, run:\r\n\r\n```shell\r\npip install pytket-pysimplex\r\n```\r\n\r\nThis will install `pytket` if it isn't already installed, and add new classes\r\nand methods into the `pytket.extensions` namespace.\r\n\r\n## Bugs, support and feature requests\r\n\r\nPlease file bugs and feature requests on the Github\r\n[issue tracker](https://github.com/CQCL/pytket-pysimplex/issues).\r\n\r\nThere is also a Slack channel for discussion and support. Click [here](https://tketusers.slack.com/join/shared_invite/zt-18qmsamj9-UqQFVdkRzxnXCcKtcarLRA#/shared-invite/email) to join.\r\n\r\n## Development\r\n\r\nTo install an extension in editable mode, simply change to its subdirectory\r\nwithin the `modules` directory, and run:\r\n\r\n```shell\r\npip install -e .\r\n```\r\n\r\n## Contributing\r\n\r\nPull requests are welcome. To make a PR, first fork the repo, make your proposed\r\nchanges on the `develop` branch, and open a PR from your fork. If it passes\r\ntests and is accepted after review, it will be merged in.\r\n\r\n### Code style\r\n\r\n#### Formatting\r\n\r\nAll code should be formatted using\r\n[black](https://black.readthedocs.io/en/stable/), with default options. This is\r\nchecked on the CI. The CI is currently using version 22.3.\r\n\r\n#### Type annotation\r\n\r\nOn the CI, [mypy](https://mypy.readthedocs.io/en/stable/) is used as a static\r\ntype checker and all submissions must pass its checks. You should therefore run\r\n`mypy` locally on any changed files before submitting a PR. Because of the way\r\nextension modules embed themselves into the `pytket` namespace this is a little\r\ncomplicated, but it should be sufficient to run the script `modules/mypy-check`\r\n(passing as a single argument the root directory of the module to test). The\r\nscript requires `mypy` 0.800 or above.\r\n\r\n#### Linting\r\n\r\nWe use [pylint](https://pypi.org/project/pylint/) on the CI to check compliance\r\nwith a set of style requirements (listed in `.pylintrc`). You should run\r\n`pylint` over any changed files before submitting a PR, to catch any issues.\r\n\r\n### Tests\r\n\r\nTo run the tests for a module:\r\n\r\n1. `cd` into that module's `tests` directory;\r\n2. ensure you have installed `pytest`, `hypothesis`, and any modules listed in\r\nthe `test-requirements.txt` file (all via `pip`);\r\n3. run `pytest`.\r\n\r\nWhen adding a new feature, please add a test for it. When fixing a bug, please\r\nadd a test that demonstrates the fix.\r\n",
"bugtrack_url": null,
"license": "Apache 2",
"summary": "Extension for pytket, providing access to the pysimplex Clifford simulator",
"version": "0.15.0",
"project_urls": {
"Documentation": "https://tket.quantinuum.com/extensions/pytket-pysimplex/index.html",
"Source": "https://github.com/CQCL/pytket-pysimplex",
"Tracker": "https://github.com/CQCL/pytket-pysimplex/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1f2d8d2861e677c91048405d5fb6e0bb0732e2e586fca5441d4b7e6620670ee1",
"md5": "1235566e905cf19cd46710f9834788b4",
"sha256": "0b278d47de28010ed6f1fc72b071c11f5ce1d2ba9ee60434d0ad327869e2809e"
},
"downloads": -1,
"filename": "pytket_pysimplex-0.15.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1235566e905cf19cd46710f9834788b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.10",
"size": 11223,
"upload_time": "2024-04-17T14:47:35",
"upload_time_iso_8601": "2024-04-17T14:47:35.572245Z",
"url": "https://files.pythonhosted.org/packages/1f/2d/8d2861e677c91048405d5fb6e0bb0732e2e586fca5441d4b7e6620670ee1/pytket_pysimplex-0.15.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 14:47:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CQCL",
"github_project": "pytket-pysimplex",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pytket-pysimplex"
}
