📝 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.

Author: burgholzer

.github/contributing.rst

@@ -6,7 +6,7 @@ We value contributions from people with all levels of experience.
 In particular if this is your first pull request not everything has to be perfect.
 We will guide you through the process.
 
-We use GitHub to `host code <https://github.com/cda-tum/qmap>`_, to `track issues and feature requests <https://github.com/cda-tum/qmap/issues>`_, as well as accept `pull requests <https://github.com/cda-tum/qmap/pulls>`_.
+We use GitHub to `host code <https://github.com/cda-tum/mqt-qmap>`_, to `track issues and feature requests <https://github.com/cda-tum/mqt-qmap/issues>`_, as well as accept `pull requests <https://github.com/cda-tum/mqt-qmap/pulls>`_.
 See https://docs.github.com/en/get-started/quickstart for a general introduction to working with GitHub and contributing to projects.
 
 Types of Contributions
@@ -15,19 +15,19 @@ Types of Contributions
 You can contribute in several ways:
 
 - 🐛 Report Bugs
-    Report bugs at https://github.com/cda-tum/qmap/issues using the *🐛 Bug report* issue template. Please make sure to fill out all relevant information in the respective issue form.
+    Report bugs at https://github.com/cda-tum/mqt-qmap/issues using the *🐛 Bug report* issue template. Please make sure to fill out all relevant information in the respective issue form.
 
 - 🐛 Fix Bugs
-    Look through the `GitHub Issues <https://github.com/cda-tum/qmap/issues>`_ for bugs. Anything tagged with "bug" is open to whoever wants to try and fix it.
+    Look through the `GitHub Issues <https://github.com/cda-tum/mqt-qmap/issues>`_ for bugs. Anything tagged with "bug" is open to whoever wants to try and fix it.
 
 - ✨ Propose New Features
-    Propose new features at https://github.com/cda-tum/qmap/issues using the *✨ Feature request* issue template. Please make sure to fill out all relevant information in the respective issue form.
+    Propose new features at https://github.com/cda-tum/mqt-qmap/issues using the *✨ Feature request* issue template. Please make sure to fill out all relevant information in the respective issue form.
 
 - ✨ Implement New Features
-    Look through the `GitHub Issues <https://github.com/cda-tum/qmap/issues>`_ for features. Anything tagged with "feature" is open to whoever wants to implement it. We highly appreciate external contributions to the project.
+    Look through the `GitHub Issues <https://github.com/cda-tum/mqt-qmap/issues>`_ for features. Anything tagged with "feature" is open to whoever wants to implement it. We highly appreciate external contributions to the project.
 
 - 📝 Write Documentation
-    QMAP could always use some more `documentation <https://mqtqmap.readthedocs.io/en/latest/>`_, and we appreciate any help with that.
+    QMAP could always use some more `documentation <https://mqt.readthedocs.io/projects/qmap>`_, and we appreciate any help with that.
 
 🎉 Get Started
 ##############

.github/support.rst

@@ -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 `quantum.cda@xcit.tum.de <mailto:quantum.cda@xcit.tum.de>`_.

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Chair for Design Automation, Technical University of Munich
+Copyright (c) 2023 Chair for Design Automation, Technical University of Munich
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,31 +1,31 @@
 [![PyPI](https://img.shields.io/pypi/v/mqt.qmap?logo=pypi&style=flat-square)](https://pypi.org/project/mqt.qmap/)
 ![OS](https://img.shields.io/badge/os-linux%20%7C%20macos%20%7C%20windows-blue?style=flat-square)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)
-[![CI](https://img.shields.io/github/actions/workflow/status/cda-tum/qmap/ci.yml?branch=main&style=flat-square&logo=github&label=c%2B%2B)](https://github.com/cda-tum/qmap/actions/workflows/ci.yml)
-[![Python-CI](https://img.shields.io/github/actions/workflow/status/cda-tum/qmap/python-ci.yml?branch=main&style=flat-square&logo=github&label=python)](https://github.com/cda-tum/qmap/actions/workflows/python-ci.yml)
-[![Bindings](https://img.shields.io/github/actions/workflow/status/cda-tum/qmap/deploy.yml?branch=main&style=flat-square&logo=github&label=packaging)](https://github.com/cda-tum/qmap/actions/workflows/deploy.yml)
-[![Documentation](https://img.shields.io/readthedocs/mqtqmap?logo=readthedocs&style=flat-square)](https://mqtqmap.readthedocs.io/en/latest/)
-[![codecov](https://img.shields.io/codecov/c/github/cda-tum/qmap?style=flat-square&logo=codecov)](https://codecov.io/gh/cda-tum/qmap)
+[![CI](https://img.shields.io/github/actions/workflow/status/cda-tum/mqt-qmap/ci.yml?branch=main&style=flat-square&logo=github&label=c%2B%2B)](https://github.com/cda-tum/mqt-qmap/actions/workflows/ci.yml)
+[![Python-CI](https://img.shields.io/github/actions/workflow/status/cda-tum/mqt-qmap/python-ci.yml?branch=main&style=flat-square&logo=github&label=python)](https://github.com/cda-tum/mqt-qmap/actions/workflows/python-ci.yml)
+[![Bindings](https://img.shields.io/github/actions/workflow/status/cda-tum/mqt-qmap/deploy.yml?branch=main&style=flat-square&logo=github&label=packaging)](https://github.com/cda-tum/mqt-qmap/actions/workflows/deploy.yml)
+[![Documentation](https://img.shields.io/readthedocs/mqtqmap?logo=readthedocs&style=flat-square)](https://mqt.readthedocs.io/projects/qmap)
+[![codecov](https://img.shields.io/codecov/c/github/cda-tum/mqt-qmap?style=flat-square&logo=codecov)](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 [quantum.cda@xcit.tum.de](mailto:quantum.cda@xcit.tum.de) 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 [quantum.cda@xcit.tum.de](mailto:quantum.cda@xcit.tum.de) 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).
 

docs/source/DevelopmentGuide.rst

@@ -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 git@github.com:your_name_here/qmap --recursive
+        $ git clone git@github.com: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
 

docs/source/Installation.rst

@@ -1,7 +1,7 @@
 Installation
 ============
 
-QMAP is mainly developed as a C++ library that builds upon `our quantum functionality representation (QFR) <https://github.com/cda-tum/qfr>`_.
+QMAP is mainly developed as a C++ library that builds upon `MQT Core <https://github.com/cda-tum/mqt-core>`_, which forms the backbone of the `MQT <https://mqt.readthedocs.io>`_.
 In order to make the tool as accessible as possible, it comes with an easy-to-use Python interface.
 
 We encourage installing QMAP via pip (preferably in a `virtual environment <https://docs.python.org/3/library/venv.html>`_):
@@ -118,7 +118,7 @@ This requires a `C++ compiler <https://en.wikipedia.org/wiki/List_of_compilers#C
 - Build Z3 from source and install it to the system
 
 The library is continuously tested under Linux, MacOS, and Windows using the `latest available system versions for GitHub Actions <https://github.com/actions/virtual-environments>`_.
-In order to access the latest build logs, visit `qmap/actions/workflows/ci.yml <https://github.com/cda-tum/qmap/actions/workflows/ci.yml>`_.
+In order to access the latest build logs, visit `mqt-qmap/actions/workflows/ci.yml <https://github.com/cda-tum/mqt-qmap/actions/workflows/ci.yml>`_.
 
 .. note::
     We noticed some issues when compiling with Microsoft's *MSCV* compiler toolchain. If you want to start development on this project under Windows, consider using the *clang* compiler toolchain. A detailed description of how to set this up can be found `here <https://docs.microsoft.com/en-us/cpp/build/clang-support-msbuild?view=msvc-160>`_.

docs/source/index.rst

@@ -1,7 +1,7 @@
 Welcome to QMAP's documentation!
 ================================
 
-QMAP is a tool for quantum circuit compilation developed as part of the *Munich Quantum Toolkit* (*MQT*) [#]_ 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>`_.
+QMAP is a tool for quantum circuit compilation developed as part of the `Munich Quantum Toolkit <https://mqt.readthedocs.io>`_ (*MQT*) [#]_ 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.
 
 We recommend you to start with the :doc:`installation instructions <Installation>` or by reading our overview paper :cite:labelpar:`wille2023qmap`.
 Then proceed to the :doc:`mapping page <Mapping>` or the :doc:`synthesis/optimization page <Synthesis>` and read the :doc:`reference documentation <library/Library>`.

pyproject.toml

@@ -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 = "sarah.schneider@jku.at" },
     { name = "Stefan Hillmich", email = "stefan.hillmich@jku.at" },
     { name = "Tom Peham", email = "tom.peham@tum.de" }
@@ -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]