-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 Prepare docs for new release (#360)
## Description This PR just fixes up a couple of things throughout the documentation regarding the move from `qmap` to `mqt-qmap` and from the `QFR` library to `MQT Core`. ## Checklist: <!--- This checklist serves as a reminder of a couple of things that ensure your pull request will be merged swiftly. --> - [x] The pull request only contains commits that are related to it. - [x] I have added appropriate tests and documentation. - [x] I have made sure that all CI jobs on GitHub pass. - [x] The pull request introduces no new warnings and follows the project's style guidelines.
- Loading branch information
Showing
8 changed files
with
34 additions
and
34 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
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,12 +1,12 @@ | ||
| Support | ||
| ======= | ||
|
|
||
| If you are stuck with a problem using QMAP or are having questions, please do get in touch at our `Issues <https://github.com/cda-tum/qmap/issues>`_ or `Discussions <https://github.com/cda-tum/qmap/discussions>`_. We'd love to help. | ||
| If you are stuck with a problem using QMAP or are having questions, please do get in touch at our `Issues <https://github.com/cda-tum/mqt-qmap/issues>`_ or `Discussions <https://github.com/cda-tum/mqt-qmap/discussions>`_. We'd love to help. | ||
|
|
||
| You can save time by following this procedure when reporting a problem: | ||
|
|
||
| - Do try to solve the problem on your own first. Make sure to consult the `Documentation <https://mqtqmap.readthedocs.io/en/latest/>`_. | ||
| - Search through past `Issues <https://github.com/cda-tum/qmap/issues>`_ to see if someone else already had the same problem. | ||
| - Do try to solve the problem on your own first. Make sure to consult the `Documentation <https://mqt.readthedocs.io/projects/qmap>`_. | ||
| - Search through past `Issues <https://github.com/cda-tum/mqt-qmap/issues>`_ to see if someone else already had the same problem. | ||
| - Before filing a bug report, try to create a minimal working example (MWE) that reproduces the problem. It's much easier to identify the cause for the problem if a handful of lines suffice to show that something isn't working. | ||
|
|
||
| You can also always reach us at `[email protected] <mailto:[email protected]>`_. |
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
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,31 +1,31 @@ | ||
| [](https://pypi.org/project/mqt.qmap/) | ||
|  | ||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://github.com/cda-tum/qmap/actions/workflows/ci.yml) | ||
| [](https://github.com/cda-tum/qmap/actions/workflows/python-ci.yml) | ||
| [](https://github.com/cda-tum/qmap/actions/workflows/deploy.yml) | ||
| [](https://mqtqmap.readthedocs.io/en/latest/) | ||
| [](https://codecov.io/gh/cda-tum/qmap) | ||
| [](https://github.com/cda-tum/mqt-qmap/actions/workflows/ci.yml) | ||
| [](https://github.com/cda-tum/mqt-qmap/actions/workflows/python-ci.yml) | ||
| [](https://github.com/cda-tum/mqt-qmap/actions/workflows/deploy.yml) | ||
| [](https://mqt.readthedocs.io/projects/qmap) | ||
| [](https://codecov.io/gh/cda-tum/mqt-qmap) | ||
|
|
||
| <p align="center"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/qmap/main/docs/source/_static/mqt_light.png" width="60%"> | ||
| <img src="https://raw.githubusercontent.com/cda-tum/qmap/main/docs/source/_static/mqt_dark.png" width="60%"> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt-qmap/main/docs/source/_static/mqt_light.png" width="60%"> | ||
| <img src="https://raw.githubusercontent.com/cda-tum/mqt-qmap/main/docs/source/_static/mqt_dark.png" width="60%"> | ||
| </picture> | ||
| </p> | ||
|
|
||
| # MQT QMAP - A tool for Quantum Circuit Compilation | ||
|
|
||
| A tool for quantum circuit compilation developed as part of the _Munich Quantum Toolkit_ (_MQT_)[^1] by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/). | ||
| It builds upon [our quantum functionality representation (QFR)](https://github.com/cda-tum/qfr). | ||
| A tool for quantum circuit compilation developed as part of the [_Munich Quantum Toolkit_](https://mqt.readthedocs.io) (_MQT_)[^1] by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/). | ||
| It builds upon [MQT Core](https://github.com/cda-tum/mqt-core), which forms the backbone of the MQT. | ||
|
|
||
| <p align="center"> | ||
| <a href="https://mqtqmap.readthedocs.io/en/latest/"> | ||
| <a href="https://mqt.readthedocs.io/projects/qmap"> | ||
| <img width=30% src="https://img.shields.io/badge/documentation-blue?style=for-the-badge&logo=read%20the%20docs" alt="Documentation" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| If you have any questions, feel free to contact us via [[email protected]](mailto:[email protected]) or by creating an issue on [GitHub](https://github.com/cda-tum/qmap/issues). | ||
| If you have any questions, feel free to contact us via [[email protected]](mailto:[email protected]) or by creating an issue on [GitHub](https://github.com/cda-tum/mqt-qmap/issues). | ||
|
|
||
| ## Getting Started | ||
|
|
||
|
|
@@ -71,12 +71,12 @@ circ.h(1) | |
| circ_opt, results = qmap.optimize_clifford(circ) | ||
| ``` | ||
|
|
||
| **Detailed documentation on all available methods, options, and input formats is available at [ReadTheDocs](https://mqtqmap.readthedocs.io/en/latest/).** | ||
| **Detailed documentation on all available methods, options, and input formats is available at [ReadTheDocs](https://mqt.readthedocs.io/projects/qmap).** | ||
|
|
||
| ## System Requirements and Building | ||
|
|
||
| The implementation is compatible with any C++17 compiler, a minimum CMake version of 3.19, and Python 3.8+. | ||
| Please refer to the [documentation](https://mqtqmap.readthedocs.io/en/latest/) on how to build the project. | ||
| Please refer to the [documentation](https://mqt.readthedocs.io/projects/qmap) on how to build the project. | ||
|
|
||
| Building (and running) is continuously tested under Linux, macOS, and Windows using the [latest available system versions for GitHub Actions](https://github.com/actions/virtual-environments). | ||
|
|
||
|
|
||
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 |
|---|---|---|
|
|
@@ -6,13 +6,13 @@ Ready to contribute to the project? Here is how to set up a local development en | |
| Initial Setup | ||
| ############# | ||
|
|
||
| 1. Fork the `cda-tum/qmap <https://github.com/cda-tum/qmap>`_ repository on GitHub (see https://docs.github.com/en/get-started/quickstart/fork-a-repo). | ||
| 1. Fork the `cda-tum/mqt-qmap <https://github.com/cda-tum/mqt-qmap>`_ repository on GitHub (see https://docs.github.com/en/get-started/quickstart/fork-a-repo). | ||
|
|
||
| 2. Clone your fork locally | ||
|
|
||
| .. code-block:: console | ||
| $ git clone [email protected]:your_name_here/qmap --recursive | ||
| $ git clone [email protected]:your_name_here/mqt-qmap --recursive | ||
| .. warning:: | ||
|
|
||
|
|
@@ -23,7 +23,7 @@ Initial Setup | |
|
|
||
| .. code-block:: console | ||
| $ cd qmap | ||
| $ cd mqt-qmap | ||
| 4. Create a branch for local development | ||
|
|
||
|
|
||
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
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
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 |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ name = "mqt.qmap" | |
| description = "A tool for Quantum Circuit Mapping" | ||
| readme = "README.md" | ||
| authors = [ | ||
| { name = "Lukas Burgholzer", email = "lukas.burgholzer@jku.at" }, | ||
| { name = "Lukas Burgholzer", email = "lukas.burgholzer@tum.de" }, | ||
| { name = "Sarah Schneider", email = "[email protected]" }, | ||
| { name = "Stefan Hillmich", email = "[email protected]" }, | ||
| { name = "Tom Peham", email = "[email protected]" } | ||
|
|
@@ -68,10 +68,10 @@ docs = [ | |
| dev = ["mqt.qmap[coverage, docs]"] | ||
|
|
||
| [project.urls] | ||
| Homepage = "https://github.com/cda-tum/qmap" | ||
| Documentation = "https://mqtqmap.readthedocs.io" | ||
| "Bug Tracker" = "https://github.com/cda-tum/qmap/issues" | ||
| Discussions = "https://github.com/cda-tum/qmap/discussions" | ||
| Homepage = "https://github.com/cda-tum/mqt-qmap" | ||
| Documentation = "https://mqt.readthedocs.io/projects/qmap" | ||
| "Bug Tracker" = "https://github.com/cda-tum/mqt-qmap/issues" | ||
| Discussions = "https://github.com/cda-tum/mqt-qmap/discussions" | ||
| Research = "https://www.cda.cit.tum.de/research/ibm_qx_mapping/" | ||
|
|
||
| [tool.setuptools.packages.find] | ||
|
|
||