From 41dd7c63118b48c884f5ee39306bfb2aad428056 Mon Sep 17 00:00:00 2001 From: Muhammad Farooqi Date: Thu, 15 May 2025 11:20:30 +0200 Subject: [PATCH 1/3] updated docs --- README.md | 4 +--- docs/user_guide/development_guide.md | 17 ++++------------- 2 files changed, 5 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index d73fa50..16e309c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # MQSS Qiskit Adapter -[![Documentation](https://img.shields.io/badge/Documentation-Read%20the%20Docs-blue)](https://munich-quantum-software-stack.github.io/MQSS-Qiskit-Adapter/)\ +[![Documentation](https://img.shields.io/badge/Documentation-Read%20the%20Docs-blue)](https://munich-quantum-software-stack.github.io/MQSS-Interfaces/qiskit/index.html)\ ![PyPI - Version](https://img.shields.io/pypi/v/mqss-qiskit)\ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mqss-qiskit)\ -![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/:user/:repo/:workflow)\ -![GitHub License](https://img.shields.io/github/license/Munich-Quantum-Software-Stack/MQSS-Qiskit-Adapter) diff --git a/docs/user_guide/development_guide.md b/docs/user_guide/development_guide.md index f1177d0..cc1cf49 100644 --- a/docs/user_guide/development_guide.md +++ b/docs/user_guide/development_guide.md @@ -18,7 +18,7 @@ Qiskit. The main components of the project are: Before you start developing, ensure you have the following installed: -- Python 3.8 to 3.11 +- Python 3.9 to 3.13 - [`uv`](https://docs.astral.sh/uv/) package manager for python ## Setting Up the Development Environment @@ -44,9 +44,9 @@ To run the tests, use `pytest`: uv run pytest ``` -## Publishing Documentation on GitHub Pages +## Building Documentation -To publish the documentation on GitHub Pages, follow these steps: +To build the documentation, follow these steps: **Install MkDocs and the Material theme:** @@ -60,7 +60,7 @@ uv sync uv run mkdocs build ``` -**View documentation locally** +**Local deployment** Run the following and browse the documentation locally at: [http://localhost:8000](http://localhost:8000) @@ -68,12 +68,3 @@ Run the following and browse the documentation locally at: ```sh uv run mkdocs serve ``` - -**Deploy the documentation to GitHub Pages:** - -```sh -uv run mkdocs gh-deploy --remote-name git@github.com:Munich-Quantum-Software-Stack/MQSS-Qiskit-Adapter.git --remote-branch gh-pages -``` - -This will create a new branch named `gh-pages` in your repository and deploy the documentation to -GitHub Pages. From e38aa64739c5cbabba7b96dfe843bfa9aea1ab8d Mon Sep 17 00:00:00 2001 From: Muhammad Farooqi Date: Thu, 15 May 2025 11:54:15 +0200 Subject: [PATCH 2/3] update readme --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 46 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 16e309c..c6dec79 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,48 @@ # MQSS Qiskit Adapter -[![Documentation](https://img.shields.io/badge/Documentation-Read%20the%20Docs-blue)](https://munich-quantum-software-stack.github.io/MQSS-Interfaces/qiskit/index.html)\ -![PyPI - Version](https://img.shields.io/pypi/v/mqss-qiskit)\ -![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mqss-qiskit)\ +[![Documentation](https://img.shields.io/badge/Documentation-Read%20the%20Docs-blue)](https://munich-quantum-software-stack.github.io/MQSS-Interfaces/qiskit/index.html) +![PyPI - Version](https://img.shields.io/pypi/v/mqss-qiskit) +![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mqss-qiskit) + +This repository implements a Qiskit Adapter, which is able to send quantum jobs to LRZ's +infrastructure. + +## Installation + +To install the package, simply run + +```bash +pip install mqss-qiskit +``` + +## Usage + +MQSS Qiskit Adapter has support for most of the basic features that a Qiskit provider implement. For +all available features, see the detailed +[documentation](https://munich-quantum-software-stack.github.io/MQSS-Interfaces/qiskit/index.html). + +```python +from mqss.qiskit_adapter import MQSSQiskitAdapter +from qiskit.circuit import QuantumCircuit + +#Create a quantum circuit +qc = QuantumCircuit(2) +qc.h(0) +qc.cx(0, 1) +qc.measure_all() + +# Get the right backend +mqss_adapter = MQSSQiskitAdapter(token="") +[backend] = mqss_adapter.backends(name="") + +# Submit the jobs +job = backend.run(qc, shots=100) + +# Get the results +print(job.result().get_counts()) + +``` + +## Contributing + +Feel free to open issues or submit pull requests to improve this project! From 5d2ae144df9eddd184fa9bfeaa5ed39332c0899a Mon Sep 17 00:00:00 2001 From: Muhammad Farooqi Date: Thu, 15 May 2025 12:12:50 +0200 Subject: [PATCH 3/3] add portal address --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c6dec79..26e9d4f 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ qc.h(0) qc.cx(0, 1) qc.measure_all() -# Get the right backend +# Get the desired backend mqss_adapter = MQSSQiskitAdapter(token="") [backend] = mqss_adapter.backends(name="") @@ -43,6 +43,8 @@ print(job.result().get_counts()) ``` +To get a token and see available backends visit [MQP](https://portal.quantum.lrz.de). + ## Contributing Feel free to open issues or submit pull requests to improve this project!