https://github.com/CQCL/pytket-qiskit

pytket-qiskit, extensions for pytket quantum SDK
https://github.com/CQCL/pytket-qiskit

Last synced: 17 days ago
JSON representation

pytket-qiskit, extensions for pytket quantum SDK

• Host: GitHub
• URL: https://github.com/CQCL/pytket-qiskit
• Owner: CQCL
• License: apache-2.0
• Created: 2022-10-05T13:13:25.000Z (over 1 year ago)
• Default Branch: develop
• Last Pushed: 2024-04-22T11:13:17.000Z (2 months ago)
• Last Synced: 2024-04-22T12:30:42.715Z (2 months ago)
• Language: Python
• Size: 6.34 MB
• Stars: 12
• Watchers: 7
• Forks: 10
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Lists

• awesome-qiskit - pytket-qiskit - An extension to pytket (a python module for interfacing with cqc tket) that allows pytket circuits to be run on ibm backends and simulators, as well as conversion to and from qiskit representations. (Community)

README

        
# pytket-qiskit

[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-qiskit` is an extension to `pytket` that allows `pytket` circuits to be

run on IBM backends and simulators, as well as conversion to and from Qiskit

representations.

## Getting started

`pytket-qiskit` is available for Python 3.10, 3.11 and 3.12, on Linux, MacOS

and Windows. To install, run:

```shell

pip install pytket-qiskit

```

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-qiskit/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.