diff --git a/README.md b/README.md index a96eb287..71e4f97c 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ # MQT DDSIM - A quantum circuit simulator based on decision diagrams written in C++ -A tool for classical quantum circuit simulation 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/). +A tool for classical quantum circuit simulation 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.

@@ -74,4 +74,28 @@ DDSIM has been developed based on methods proposed in the following papers: - L. Burgholzer, A.Ploier, and R. Wille, "[Exploiting Arbitrary Paths for the Simulation of Quantum Circuits with Decision Diagrams](https://www.cda.cit.tum.de/files/eda/2022_date_exploiting_arbitrary_paths_simulation_quantum_circuits_decision_diagrams.pdf)," in Design, Automation and Test in Europe (DATE), 2022 - T. Grurl, J. Fuß, and R. Wille, "[Noise-aware Quantum Circuit Simulation With Decision Diagrams](https://www.cda.cit.tum.de/files/eda/2022_tcad_noise-aware_quantum_circuit_simulation_with_decision_diagrams.pdf)," Transactions on CAD of Integrated Circuits and Systems (TCAD), 2022. -[^1]: The Munich Quantum Toolkit was formerly known under the acronym _JKQ_ and developed by the [Institute for Integrated Circuits](https://iic.jku.at/eda/) at the [Johannes Kepler University Linz](https://jku.at)). +--- + +## Acknowledgements + +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. + +

+ + + + + + + + + + + + + + +

diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css new file mode 100644 index 00000000..10d1b04d --- /dev/null +++ b/docs/source/_static/custom.css @@ -0,0 +1,22 @@ +.acknowledgements { + margin-top: 1rem; + padding-bottom: 1rem; + padding-top: 1rem; + border-top: 1px solid var(--color-background-border); + font-size: var(--font-size--small); + color: var(--color-foreground-secondary); +} + +.acknowledgements-logos { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(100px, 1fr)); + grid-gap: 1em; + align-items: center; + margin-top: 0.5rem; +} +.acknowledgement { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; +} diff --git a/docs/source/_static/erc_dark.svg b/docs/source/_static/erc_dark.svg new file mode 100644 index 00000000..f27e840e --- /dev/null +++ b/docs/source/_static/erc_dark.svg @@ -0,0 +1,1120 @@ + +image/svg+xml diff --git a/docs/source/_static/erc_light.svg b/docs/source/_static/erc_light.svg new file mode 100644 index 00000000..5f712dd4 --- /dev/null +++ b/docs/source/_static/erc_light.svg @@ -0,0 +1,1125 @@ + +image/svg+xml diff --git a/docs/source/_static/logo-bavaria.svg b/docs/source/_static/logo-bavaria.svg new file mode 100644 index 00000000..3af589f3 --- /dev/null +++ b/docs/source/_static/logo-bavaria.svg @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/_static/logo-mqv.svg b/docs/source/_static/logo-mqv.svg new file mode 100644 index 00000000..7eca062e --- /dev/null +++ b/docs/source/_static/logo-mqv.svg @@ -0,0 +1,2 @@ + +image/svg+xml diff --git a/docs/source/_static/tum_dark.svg b/docs/source/_static/tum_dark.svg new file mode 100644 index 00000000..571a0cc3 --- /dev/null +++ b/docs/source/_static/tum_dark.svg @@ -0,0 +1,130 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/_static/tum_light.svg b/docs/source/_static/tum_light.svg new file mode 100644 index 00000000..763f70b0 --- /dev/null +++ b/docs/source/_static/tum_light.svg @@ -0,0 +1,130 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/_templates/page.html b/docs/source/_templates/page.html new file mode 100644 index 00000000..a5113eda --- /dev/null +++ b/docs/source/_templates/page.html @@ -0,0 +1,61 @@ +{% extends "furo/page.html" %} {% block footer %} +
+ {% if next -%} + +
+
+ {{ _("Next") }} +
+
{{ next.title }}
+
+ + + {%- endif %} {% if prev -%} + + +
+
+ {{ _("Previous") }} +
+ {% if prev.link == pathto(master_doc) %} +
{{ _("Home") }}
+ {% else %} +
{{ prev.title }}
+ {% endif %} +
+ + {%- endif %} +
+
+ 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. +
+
+ TUM +
+
+ TUM +
+
+ Bavaria +
+
+ ERC +
+
+ ERC +
+
+ MQV +
+
+
+{% endblock footer %} diff --git a/docs/source/conf.py b/docs/source/conf.py index 3e0fcaeb..ec62597b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,6 +12,10 @@ from pybtex.style.formatting.unsrt import Style as UnsrtStyle from pybtex.style.template import field, href +if TYPE_CHECKING: + from pybtex.database import Entry + from pybtex.richtext import HRef + ROOT = Path(__file__).parent.parent.resolve() @@ -34,17 +38,16 @@ # Filter git details from version release = version.split("+")[0] -if TYPE_CHECKING: - from pybtex.database import Entry - from pybtex.richtext import HRef - -# -- Project information ----------------------------------------------------- project = "DDSIM" author = "Stefan Hillmich" language = "en" project_copyright = "Chair for Design Automation, Technical University of Munich" -# -- General configuration --------------------------------------------------- +master_doc = "index" + +templates_path = ["_templates"] +html_css_files = ["custom.css"] + extensions = [ "sphinx.ext.napoleon", "sphinx.ext.autodoc", diff --git a/docs/source/index.rst b/docs/source/index.rst index 47c55dad..8d86a2b8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,7 @@ Welcome to MQT DDSIM's documentation! ===================================== -DDSIM is a tool for quantum circuit simulation developed as part of the `Munich Quantum Toolkit `_ (*MQT*) [#]_ by the `Chair for Design Automation `_ at the `Technical University of Munich `_. It builds upon `MQT Core `_, which forms the backbone of the MQT. +DDSIM is a tool for quantum circuit simulation developed as part of the `Munich Quantum Toolkit `_ (*MQT*) by the `Chair for Design Automation `_ at the `Technical University of Munich `_. It builds upon `MQT Core `_, which forms the backbone of the MQT. We recommend you to start with the :doc:`installation instructions ` and then proceed to the :doc:`quickstart guide `. If you are interested in the theory behind QCEC, have a look at the publications in the :doc:`publication list `. @@ -44,9 +44,3 @@ We appreciate any feedback and contributions to the project. If you want to cont api/modules api/Cpp - ----- - -.. rubric:: Footnotes - -.. [#] The Munich Quantum Toolkit was formerly known under the acronym *JKQ* :cite:labelpar:`wille2020JKQtools` and developed by the `Institute for Integrated Circuits `_ at the `Johannes Kepler University Linz `_.