Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨📖✨ The MQT Handbook #10

Merged
merged 33 commits into from
May 3, 2024
Merged

✨📖✨ The MQT Handbook #10

merged 33 commits into from
May 3, 2024

Conversation

burgholzer
Copy link
Member

This (work-in-progress) PR brings the first version of the MQT Handbook, which aims to become the main reference for the Munich Quantum Toolkit.

The resulting document is hosted live at https://mqt.readthedocs.io/. In addition, a corresponding PDF can be downloaded straight from the website. This PDF is generated based on an automatically generated LaTeX file.

@burgholzer burgholzer added documentation Improvements or additions to documentation feature New feature or request major Part of a major release labels Apr 8, 2024
@burgholzer burgholzer self-assigned this Apr 8, 2024
@burgholzer
Copy link
Member Author

Thanks @nquetschlich for the (offline) feedback. I incorporated most of it.
The current live version can be seen at: https://mqt--10.org.readthedocs.build/en/10/

The current PDF is attached in this message:
mqt_handbook.pdf

It can easily be generated by running

nox -s docs -- -b latex
cd docs/_build/latex
make

Any further feedback is welcome.

Copy link
Member

@pehamTom pehamTom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again for setting up everything and writing the paper!

I added some comments on things that could use either references or rewording.

docs/handbook/01_intro.md Outdated Show resolved Hide resolved
docs/handbook/01_intro.md Outdated Show resolved Hide resolved
docs/handbook/01_intro.md Outdated Show resolved Hide resolved
docs/handbook/01_intro.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/handbook/02_simulation.md Outdated Show resolved Hide resolved
docs/handbook/07_conclusions.md Show resolved Hide resolved
@burgholzer burgholzer marked this pull request as ready for review April 23, 2024 10:49
Co-authored-by: Lucas Berent <lucas.berent@tum.de>
Co-authored-by: Nils Quetschlich <nilsq8@gmail.com>
Co-authored-by: Lucas Berent <lucas.berent@tum.de>
docs/handbook/01_intro.md Outdated Show resolved Hide resolved
docs/refs.bib Outdated Show resolved Hide resolved
burgholzer and others added 2 commits April 24, 2024 19:03
Co-authored-by: Lucas Berent <lucas.berent@tum.de>
Co-authored-by: Ludwig Schmid <ludwig.s.schmid@tum.de>
@burgholzer
Copy link
Member Author

Thanks again to everyone that provided feedback so far! Greatly appreciated.
I tried to incorporate as much of the feedback as possible.
Since the deadline for the submission is soon, I would now consider this pre-final for the submission. Any further big modifications will probably have to wait for a final version.

@burgholzer burgholzer merged commit 267d77a into main May 3, 2024
2 checks passed
@burgholzer burgholzer deleted the mqt-handbook branch May 3, 2024 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature or request major Part of a major release
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants