Readme docs (#19)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Lukas Burgholzer <[email protected]>
cda-tum · Apr 30, 2024 · 9132bc2 · 9132bc2
1 parent 79a80ae
commit 9132bc2
Show file tree

Hide file tree

Showing 16 changed files with 999 additions and 1,718 deletions.
diff --git a/MQT_Qudits_Tutorial/2dqed.png b/MQT_Qudits_Tutorial/2dqed.png
diff --git a/MQT_Qudits_Tutorial/MQT Qudits Tutorial-checkpoint.ipynb b/MQT_Qudits_Tutorial/MQT Qudits Tutorial-checkpoint.ipynb
diff --git a/MQT_Qudits_Tutorial/MQT Qudits Tutorial.ipynb b/MQT_Qudits_Tutorial/MQT Qudits Tutorial.ipynb
diff --git a/MQT_Qudits_Tutorial/foot.png b/MQT_Qudits_Tutorial/foot.png
diff --git a/README.md b/README.md
@@ -72,27 +72,28 @@ MQT Qudits has been developed based on methods proposed in the following papers:
 ## Acknowledgements
 
 MQT Qudits is the result of the project NeQST funded by the European Union under Horizon Europe Programme - Grant Agreement 101080086.
-Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or European Climate, Infrastructure and Environment Executive Agency (CINEA). Neither the European Union nor the granting authority can be held responsible for them.
+Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union
+or the European Commission. Neither the European Union nor the granting authority can be held responsible for them.
 
 The Munich Quantum Toolkit has been supported by the European Research Council (ERC) under the European Union's Horizon 2020 research and innovation program (grant agreement No. 101001318), the Bavarian State Ministry for Science and Arts through the Distinguished Professorship Program, as well as the Munich Quantum Valley, which is supported by the Bavarian state government with funds from the Hightech Agenda Bayern Plus.
 
 <p align="center">
 <picture>
-<source media="(prefers-color-scheme: dark)" srcset="https://neqst-he.eu/icons/logo.svg" width="20%">
-<img src="https://neqst-he.eu/icons/logo.svg" width="20%">
+<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt-qudits/main/docs/_static/eu_funded_dark.svg" width="25%">
+<img src="https://raw.githubusercontent.com/cda-tum/mqt-qudits/main/docs/_static/eu_funded_light.svg" width="25%">
 </picture>
 <picture>
 <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt/main/docs/_static/tum_dark.svg" width="20%">
-<img src="https://raw.githubusercontent.com/cda-tum/mqt/main/docs/_static/tum_light.svg" width="20%">
+<img src="https://raw.githubusercontent.com/cda-tum/mqt/main/docs/_static/tum_light.svg" width="15%">
 </picture>
 <picture>
-<img src="https://raw.githubusercontent.com/cda-tum/mqt/main/docs/_static/logo-bavaria.svg" width="16%">
+<img src="https://raw.githubusercontent.com/cda-tum/mqt/main/docs/_static/logo-bavaria.svg" width="12%">
 </picture>
 <picture>
 <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt/main/docs/_static/erc_dark.svg" width="20%">
 <img src="https://raw.githubusercontent.com/cda-tum/mqt/main/docs/_static/erc_light.svg" width="20%">
 </picture>
 <picture>
-<img src="https://raw.githubusercontent.com/cda-tum/mqt/main/docs/_static/logo-mqv.svg" width="20%">
+<img src="https://raw.githubusercontent.com/cda-tum/mqt/main/docs/_static/logo-mqv.svg" width="18%">
 </picture>
 </p>
diff --git a/docs/_static/eu_funded_dark.svg b/docs/_static/eu_funded_dark.svg
diff --git a/docs/_static/eu_funded_light.svg b/docs/_static/eu_funded_light.svg
diff --git a/docs/_static/foot.png b/docs/_static/foot.png
diff --git a/docs/_templates/page.html b/docs/_templates/page.html
@@ -30,9 +30,8 @@
   MQT Qudits is the result of the project NeQST funded by the European Union
   under Horizon Europe Programme - Grant Agreement 101080086. Views and opinions
   expressed are however those of the author(s) only and do not necessarily
-  reflect those of the European Union or European Climate, Infrastructure and
-  Environment Executive Agency (CINEA). Neither the European Union nor the
-  granting authority can be held responsible for them. <br />
+  reflect those of the European Union or the European Commission. Neither the
+  European Union nor the granting authority can be held responsible for them.<br /><br />
 
   The Munich Quantum Toolkit has been supported by the European Research Council
   (ERC) under the European Union's Horizon 2020 research and innovation program
@@ -41,11 +40,16 @@
   Quantum Valley, which is supported by the Bavarian state government with funds
   from the Hightech Agenda Bayern Plus.
   <div class="acknowledgements-logos">
-    <div class="acknowledgement">
+    <div class="acknowledgement only-light">
       <img
-        src="https://neqst-he.eu/icons/logo.svg"
-        alt="NeQST"
-        style="width: 65%"
+        src="{{ pathto('_static/eu_funded_light.svg', 1) }}"
+        alt="Funded by the European Union"
+      />
+    </div>
+    <div class="acknowledgement only-dark">
+      <img
+        src="{{ pathto('_static/eu_funded_dark.svg', 1) }}"
+        alt="Funded by the European Union"
       />
     </div>
     <div class="acknowledgement only-light">

diff --git a/docs/publications.md b/docs/publications.md
@@ -1,6 +1,6 @@
 # Publications
 
-MQT Qudits is academic software. Thus, many of its built-in algorithms have been published as scientific papers {cite:p}`matoAdaptiveCompilationMultilevel2022,matoCompilationEntanglingGates2023,matoCompressionQubitCircuits2023,matoMixeddimensionalQuantumCircuit2023,matoMixeddimensionalQuditState2024`.
+MQT Qudits is academic software. Thus, many of its built-in algorithms have been published as scientific papers {cite:p}`matoMixeddimensionalQuditState2024,matoMixeddimensionalQuantumCircuit2023,matoCompressionQubitCircuits2023,matoCompilationEntanglingGates2023,matoAdaptiveCompilationMultilevel2022`.
 
 If you use _MQT Qudits_ in your work, we would appreciate if you cited the respective paper(s).
 

diff --git a/docs/refs.bib b/docs/refs.bib
@@ -1,17 +1,16 @@
-@inproceedings{matoAdaptiveCompilationMultilevel2022,
-  title = {Adaptive compilation of multi-level quantum operations},
-  booktitle = {International Conference on Quantum Computing and Engineering (QCE)},
-  author = {Mato, Kevin and Ringbauer, Martin and Hillmich, Stefan and Wille, Robert},
-  year = {2022},
-  doi = {10.1109/QCE53715.2022.00070},
+@inproceedings{matoMixeddimensionalQuditState2024,
+  title = {Mixed-dimensional qudit state preparation using edge-weighted decision diagrams},
+  booktitle = {Design Automation Conference (DAC)},
+  author = {Mato, Kevin and Hillmich, Stefan and Wille, Robert},
+  year = {2024}
 }
 
-@inproceedings{matoCompilationEntanglingGates2023,
-  title = {Compilation of entangling gates for high-dimensional quantum systems},
-  booktitle = {Asia and South Pacific Design Automation Conference (ASP-DAC)},
-  author = {Mato, Kevin and Ringbauer, Martin and Hillmich, Stefan and Wille, Robert},
+@inproceedings{matoMixeddimensionalQuantumCircuit2023,
+  title = {Mixed-dimensional quantum circuit simulation with decision diagrams},
+  booktitle = {International Conference on Quantum Computing and Engineering (QCE)},
+  author = {Mato, Kevin and Hillmich, Stefan and Wille, Robert},
   year = {2023},
-  doi = {10.1145/3566097.3567930},
+  doi = {10.1109/QCE57702.2023.00112},
 }
 
 @inproceedings{matoCompressionQubitCircuits2023,
@@ -22,17 +21,18 @@ @inproceedings{matoCompressionQubitCircuits2023
   doi = {10.1109/QSW59989.2023.00027},
 }
 
-@inproceedings{matoMixeddimensionalQuantumCircuit2023,
-  title = {Mixed-dimensional quantum circuit simulation with decision diagrams},
-  booktitle = {International Conference on Quantum Computing and Engineering (QCE)},
-  author = {Mato, Kevin and Hillmich, Stefan and Wille, Robert},
+@inproceedings{matoCompilationEntanglingGates2023,
+  title = {Compilation of entangling gates for high-dimensional quantum systems},
+  booktitle = {Asia and South Pacific Design Automation Conference (ASP-DAC)},
+  author = {Mato, Kevin and Ringbauer, Martin and Hillmich, Stefan and Wille, Robert},
   year = {2023},
-  doi = {10.1109/QCE57702.2023.00112},
+  doi = {10.1145/3566097.3567930},
 }
 
-@inproceedings{matoMixeddimensionalQuditState2024,
-  title = {Mixed-dimensional qudit state preparation using edge-weighted decision diagrams},
-  booktitle = {Design Automation Conference (DAC)},
-  author = {Mato, Kevin and Hillmich, Stefan and Wille, Robert},
-  year = {2024}
+@inproceedings{matoAdaptiveCompilationMultilevel2022,
+  title = {Adaptive compilation of multi-level quantum operations},
+  booktitle = {International Conference on Quantum Computing and Engineering (QCE)},
+  author = {Mato, Kevin and Ringbauer, Martin and Hillmich, Stefan and Wille, Robert},
+  year = {2022},
+  doi = {10.1109/QCE53715.2022.00070},
 }
diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -14,22 +14,15 @@ mystnb:
 # MQT Qudits Tutorial 🌌
 
 _Discover a New Dimension in Quantum Computing._
-Embark on a journey with MQT Qudits, a cutting-edge framework for Mixed-Dimensional Quantum Computing.
+Embark on a journey with MQT Qudits, a framework for Mixed-Dimensional Quantum Computing.
 
 Delve into the realm of mixed-dimensional quantum computing with NeQST—a project funded by the European Union and developed developed as part of the {doc}`Munich Quantum Toolkit (MQT) <mqt:index>` by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/).
 Our team is focused on creating design automation methods and software for quantum computing.
 The following tutorial will guide you through the initial tools and contributions we have made to advance Quantum Information Processing for Science and Technology.
 
-```{image} /_static/foot.png
-:alt: MQT Qudits Project Logos
-:width: 80%
-:align: center
-
-```
-
 +++
 
-## Installation steps:
+## Installation Steps:
 
 ```bash
 (.venv) $ pip install mqt.qudits
@@ -247,6 +240,7 @@ After crafting your quantum circuit with precision, take it for a spin using two
   - h
   - rxy
   - rz
+  - rh
   - virtrz
   - s
   - x
@@ -402,7 +396,8 @@ Tailor your quantum compilation process to achieve optimal performance and emula
 
 ### Experimental-Inspired Compilation
 
-Emulate the features of the best experimental laboratories in your compilation process. Leverage modern compiler passes to customize optimization, gate decomposition, and noise-aware strategies, creating compiled circuits that closely resemble the challenges and advantages of cutting-edge quantum hardware.
+Emulate the features of the best experimental laboratories in your compilation process.
+Leverage modern compiler passes to customize optimization, gate decomposition, and noise-aware strategies, creating compiled circuits that closely resemble the challenges and advantages of cutting-edge quantum hardware.
 
 Customize, compile, and push the boundaries of quantum algorithms with a tailored approach to quantum compilation. 🛠️🔧🚀
 

diff --git a/MQT_Qudits_Tutorial/MQT Qudits Overview.pdf → mqt-qudits-overview.pdf b/MQT_Qudits_Tutorial/MQT Qudits Overview.pdf → mqt-qudits-overview.pdf
diff --git a/src/mqt/__init__.py b/src/mqt/__init__.py
diff --git a/src/python/bindings.cpp b/src/python/bindings.cpp
@@ -9,7 +9,6 @@
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>
 #include <random>
-#include <unistd.h>
 #include <vector>
 
 namespace py = pybind11;

diff --git a/test/python/compiler/onedit/test_swap_routine.py b/test/python/compiler/onedit/test_swap_routine.py
@@ -103,7 +103,6 @@ def test_cost_calculator(self):
 
         assert total_costing == 0.00425
         assert len(pi_pulses_routing) == 2
-
         assert cost_of_pi_pulses == 0.002
 
     def test_route_states2rotate_basic(self):