# PlanQK Quantum SDK
[](https://badge.fury.io/py/planqk-quantum)
The PlanQK Quantum SDK is for developing quantum circuits using [Qiskit](https://pypi.org/project/qiskit) to be run on
quantum devices provided by the [PlanQK Platform](https://docs.planqk.de).
This library is an **extension** for Qiskit.
This means that you are able to seamlessly integrate and reuse your existing Qiskit code, leveraging the power and
familiarity of a framework you are already accustomed to.
## Getting Started
Check out the following guides on how to get started with PlanQK:
- [PlanQK Quickstart Guide](https://docs.planqk.de/quickstart.html)
- [Using the PlanQK Quantum SDK](https://docs.planqk.de/using-sdk.html)
## Installation
The package is released on PyPI and can be installed via `pip`:
```bash
pip install --upgrade planqk-quantum
```
To install a pre-release version, use the following command:
```bash
pip install --pre --upgrade planqk-quantum
```
## Development
To create a new Conda environment, run:
```bash
conda env create -f environment.yml
```
Then, to activate the environment:
```bash
conda activate planqk-quantum
```
To install the package in development mode, run:
```bash
pip install -e .
```
To update the environment, run:
```bash
conda env update -f environment.yml
```
---
## Release Process
The SDK is released to [PyPi](https://pypi.org/project/planqk-quantum).
The release numbers follow the [Semantic Versioning](https://semver.org) approach resulting in a version number in the format `major.minor.patch`.
The version number is automatically increased by the CI/CD pipeline based on your [commit message](https://github.com/semantic-release/semantic-release#commit-message-format).
### Production Release
If you push to the `main` branch and the commit message contains, for example, the prefix `feat:`, `fix:` or
`perf:` a new release will be created automatically.
You can use the keyword `BREAKING CHANGE` in the commit message to trigger a major release.
Use `chore:` or omit the prefix if you do not want a new release to be created.
**Warning:** This release will be public and affects all services using the SDK in production.
### Staging / Testing Release
If you want to create a release only for the testing environment (pre-release), perform the following steps:
1. Create a new branch from `main` and name it `dev` (make sure you delete an old `dev` branch).
This branch is used for pre-releases and its commits are not automatically released.
2. In the `dev` branch open `setup.py` file and increase the version number and add the suffix `-rcX` to it, where
`X` is the release candidate number.
If the version number is for instance `12.1.0`, then the new version number should be `12.2.0-rc1`.
3. Push your changes to the `dev` branch.
4. Go to the [GitLab repository](https://gitlab.com/planqk-foss/planqk-quantum) and click in section `Deploy` on `Releases`.
5. Click on `Draft a new release`.
6. Click on `Choose a tag`.
Enter the new version number prefixed by `v`in the `Tag version` field, e.g., `v12.2.0-rc1`.
7. Select the `dev` branch in the `Target` field.
8. Enter as title the tag name and add a description for the release.
9. Click on `Publish release`.
Do not forget to merge your changes back to the main branch once you want to release these changes to production.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/planqk-foss/planqk-quantum",
"name": "planqk-quantum",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Kipu Quantum GmbH",
"author_email": "info@kipu-quantum.com",
"download_url": "https://files.pythonhosted.org/packages/6e/81/e029ea43e0cc2eacaf56b1dd461cee4758e1cb84fe39eceafd7b2839b66a/planqk_quantum-2.14.1.tar.gz",
"platform": null,
"description": "# PlanQK Quantum SDK\n\n[](https://badge.fury.io/py/planqk-quantum)\n\nThe PlanQK Quantum SDK is for developing quantum circuits using [Qiskit](https://pypi.org/project/qiskit) to be run on\nquantum devices provided by the [PlanQK Platform](https://docs.planqk.de).\nThis library is an **extension** for Qiskit.\nThis means that you are able to seamlessly integrate and reuse your existing Qiskit code, leveraging the power and\nfamiliarity of a framework you are already accustomed to.\n\n## Getting Started\n\nCheck out the following guides on how to get started with PlanQK:\n\n- [PlanQK Quickstart Guide](https://docs.planqk.de/quickstart.html)\n- [Using the PlanQK Quantum SDK](https://docs.planqk.de/using-sdk.html)\n\n## Installation\n\nThe package is released on PyPI and can be installed via `pip`:\n\n```bash\npip install --upgrade planqk-quantum\n```\n\nTo install a pre-release version, use the following command:\n\n```bash\npip install --pre --upgrade planqk-quantum\n```\n\n## Development\n\nTo create a new Conda environment, run:\n\n```bash\nconda env create -f environment.yml\n```\n\nThen, to activate the environment:\n\n```bash\nconda activate planqk-quantum\n```\n\nTo install the package in development mode, run:\n\n```bash\npip install -e .\n```\n\nTo update the environment, run:\n\n```bash\nconda env update -f environment.yml\n```\n\n---\n\n## Release Process\n\nThe SDK is released to [PyPi](https://pypi.org/project/planqk-quantum).\nThe release numbers follow the [Semantic Versioning](https://semver.org) approach resulting in a version number in the format `major.minor.patch`.\nThe version number is automatically increased by the CI/CD pipeline based on your [commit message](https://github.com/semantic-release/semantic-release#commit-message-format).\n\n### Production Release\n\nIf you push to the `main` branch and the commit message contains, for example, the prefix `feat:`, `fix:` or\n`perf:` a new release will be created automatically.\nYou can use the keyword `BREAKING CHANGE` in the commit message to trigger a major release.\nUse `chore:` or omit the prefix if you do not want a new release to be created.\n\n**Warning:** This release will be public and affects all services using the SDK in production.\n\n### Staging / Testing Release\n\nIf you want to create a release only for the testing environment (pre-release), perform the following steps:\n\n1. Create a new branch from `main` and name it `dev` (make sure you delete an old `dev` branch).\n This branch is used for pre-releases and its commits are not automatically released.\n2. In the `dev` branch open `setup.py` file and increase the version number and add the suffix `-rcX` to it, where\n `X` is the release candidate number.\n If the version number is for instance `12.1.0`, then the new version number should be `12.2.0-rc1`.\n3. Push your changes to the `dev` branch.\n4. Go to the [GitLab repository](https://gitlab.com/planqk-foss/planqk-quantum) and click in section `Deploy` on `Releases`.\n5. Click on `Draft a new release`.\n6. Click on `Choose a tag`.\n Enter the new version number prefixed by `v`in the `Tag version` field, e.g., `v12.2.0-rc1`.\n7. Select the `dev` branch in the `Target` field.\n8. Enter as title the tag name and add a description for the release.\n9. Click on `Publish release`.\n\nDo not forget to merge your changes back to the main branch once you want to release these changes to production.\n",
"bugtrack_url": null,
"license": "apache-2.0",
"summary": "Python SDK for the PlanQK Platform",
"version": "2.14.1",
"project_urls": {
"Homepage": "https://gitlab.com/planqk-foss/planqk-quantum"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d7dddd8f3af6f2b39ee77633cd13231e137ddef2631619bd90b04e68cf558f1b",
"md5": "9df4bcca16896e30b113e0983568103b",
"sha256": "2bd832c71e1e0636cbb546e076592a32ba5b6c5cf607e3a168ceac5d2572e4c0"
},
"downloads": -1,
"filename": "planqk_quantum-2.14.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9df4bcca16896e30b113e0983568103b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 59126,
"upload_time": "2024-12-17T15:04:10",
"upload_time_iso_8601": "2024-12-17T15:04:10.293980Z",
"url": "https://files.pythonhosted.org/packages/d7/dd/dd8f3af6f2b39ee77633cd13231e137ddef2631619bd90b04e68cf558f1b/planqk_quantum-2.14.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e81e029ea43e0cc2eacaf56b1dd461cee4758e1cb84fe39eceafd7b2839b66a",
"md5": "bf253e4335325e68f07db514962fde26",
"sha256": "7270136576952901ef5e1717c9e6b43e63bd0d0548b07f0ebc87e8c49193286a"
},
"downloads": -1,
"filename": "planqk_quantum-2.14.1.tar.gz",
"has_sig": false,
"md5_digest": "bf253e4335325e68f07db514962fde26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 42781,
"upload_time": "2024-12-17T15:04:13",
"upload_time_iso_8601": "2024-12-17T15:04:13.008661Z",
"url": "https://files.pythonhosted.org/packages/6e/81/e029ea43e0cc2eacaf56b1dd461cee4758e1cb84fe39eceafd7b2839b66a/planqk_quantum-2.14.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 15:04:13",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "planqk-foss",
"gitlab_project": "planqk-quantum",
"lcname": "planqk-quantum"
}
JSON