This repository has been archived by the owner on Nov 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,79 +1 @@ | ||
# pytket-ionq | ||
|
||
This extension is currently not working and we don't expect it to be available again in the near future. | ||
|
||
[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-ionq` is an extension to `pytket` that allows `pytket` circuits to be | ||
executed on IonQ's quantum devices and simulators. | ||
|
||
## Getting started | ||
|
||
`pytket-ionq` is available for Python 3.8, 3.9 and 3.10, on Linux, MacOS | ||
and Windows. To install, run: | ||
|
||
```shell | ||
pip install pytket-ionq | ||
``` | ||
|
||
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-ionq/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 20.8b1. | ||
|
||
#### 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. | ||
**This repository is archived.** |