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

📝 Prepare docs for new release #156

Merged
merged 1 commit into from
Aug 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .github/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/qecc>`_, to `track issues and feature requests <https://github.com/cda-tum/qecc/issues>`_, as well as accept `pull requests <https://github.com/cda-tum/qecc/pulls>`_.
We use GitHub to `host code <https://github.com/cda-tum/mqt-qecc>`_, to `track issues and feature requests <https://github.com/cda-tum/mqt-qecc/issues>`_, as well as accept `pull requests <https://github.com/cda-tum/mqt-qecc/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
Expand All @@ -15,19 +15,19 @@ Types of Contributions
You can contribute in several ways:

- 🐛 Report Bugs
Report bugs at https://github.com/cda-tum/qecc/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-qecc/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/qecc/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-qecc/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/qecc/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-qecc/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/qecc/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-qecc/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
QECC could always use some more `documentation <https://qecc.readthedocs.io/en/latest/>`_, and we appreciate any help with that.
QECC could always use some more `documentation <https://mqt.readthedocs.io/projects/qecc>`_, and we appreciate any help with that.

🎉 Get Started
##############
Expand Down
6 changes: 3 additions & 3 deletions .github/support.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Support
=======

If you are stuck with a problem using QECC or are having questions, please do get in touch at our `Issues <https://github.com/cda-tum/qecc/issues>`_ or `Discussions <https://github.com/cda-tum/qecc/discussions>`_. We'd love to help.
If you are stuck with a problem using QECC or are having questions, please do get in touch at our `Issues <https://github.com/cda-tum/mqt-qecc/issues>`_ or `Discussions <https://github.com/cda-tum/mqt-qecc/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://qecc.readthedocs.io/en/latest/>`_.
- Search through past `Issues <https://github.com/cda-tum/qecc/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/qecc>`_.
- Search through past `Issues <https://github.com/cda-tum/mqt-qecc/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>`_.
33 changes: 14 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
[![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/qecc/ci.yml?branch=main&style=flat-square&logo=github&label=c%2B%2B)](https://github.com/cda-tum/qecc/actions/workflows/ci.yml)
[![Python CI](https://img.shields.io/github/actions/workflow/status/cda-tum/qecc/python-ci.yml?branch=main&style=flat-square&logo=github&label=python)](https://github.com/cda-tum/qecc/actions/workflows/python-ci.yml)
[![Bindings](https://img.shields.io/github/actions/workflow/status/cda-tum/qecc/deploy.yml?branch=main&style=flat-square&logo=github&label=packaging)](https://github.com/cda-tum/qecc/actions/workflows/deploy.yml)
[![codecov](https://img.shields.io/codecov/c/github/cda-tum/qecc?style=flat-square&logo=codecov)](https://codecov.io/gh/cda-tum/qecc)
[![CI](https://img.shields.io/github/actions/workflow/status/cda-tum/mqt-qecc/ci.yml?branch=main&style=flat-square&logo=github&label=c%2B%2B)](https://github.com/cda-tum/mqt-qecc/actions/workflows/ci.yml)
[![Python CI](https://img.shields.io/github/actions/workflow/status/cda-tum/mqt-qecc/python-ci.yml?branch=main&style=flat-square&logo=github&label=python)](https://github.com/cda-tum/mqt-qecc/actions/workflows/python-ci.yml)
[![Bindings](https://img.shields.io/github/actions/workflow/status/cda-tum/mqt-qecc/deploy.yml?branch=main&style=flat-square&logo=github&label=packaging)](https://github.com/cda-tum/mqt-qecc/actions/workflows/deploy.yml)
[![codecov](https://img.shields.io/codecov/c/github/cda-tum/mqt-qecc?style=flat-square&logo=codecov)](https://codecov.io/gh/cda-tum/mqt-qecc)

<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/qecc/main/docs/source/_static/mqt_light.png" width="60%">
<img src="https://raw.githubusercontent.com/cda-tum/qecc/main/docs/source/_static/mqt_dark.png" width="60%">
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt-qecc/main/docs/source/_static/mqt_light.png" width="60%">
<img src="https://raw.githubusercontent.com/cda-tum/mqt-qecc/main/docs/source/_static/mqt_dark.png" width="60%">
</picture>
</p>

# QECC: An MQT tool for Quantum Error Correcting Codes written in C++
# MQT QECC: A tool for Quantum Error Correcting Codes written in C++

:warning: **This project is still in early development and breaking changes might happen frequently.**

(Additionally to the basic numerical results already provided, further data will be published continually)

A tool for quantum error correcting codes and numerical simulations developed by the
[Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/)
based on methods proposed in [[1]](https://arxiv.org/abs/2209.01180). QECC is part of the Munich Quantum Toolkit (MQT).
A tool for quantum error correcting codes and numerical simulations 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.

The tool can be used to:

Expand All @@ -41,17 +36,17 @@ The tool can be used to:
with varying extent of functionality.

<p align="center">
<a href="https://qecc.readthedocs.io/en/latest/">
<a href="https://mqt.readthedocs.io/projects/qecc">
<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/qecc/issues).
creating an issue on [GitHub](https://github.com/cda-tum/mqt-qecc/issues).

## Getting Started

QECC is available via [PyPI](https://pypi.org/project/mqt.qecc/) for Linux, macOS, and Windows.
QECC is available via [PyPI](https://pypi.org/project/mqt.qecc/) for Linux and macOS and supports Python 3.8 to 3.12.

```console
(venv) $ pip install mqt.qecc
Expand Down Expand Up @@ -126,12 +121,12 @@ State |11> probability 0.477
```

**Detailed documentation on all available methods, options, and input formats is available
at [ReadTheDocs](https://qecc.readthedocs.io/en/latest/).**
at [ReadTheDocs](https://mqt.readthedocs.io/projects/qecc).**

## System Requirements and Building

The implementation is compatible with any C++17 compiler and a minimum CMake version of 3.19.
Please refer to the [documentation](https://qecc.readthedocs.io/en/latest/) on how to build the project.
Please refer to the [documentation](https://mqt.readthedocs.io/projects/qecc) on how to build the project.

Building (and running) is continuously tested under Linux and macOS using the
[latest available system versions for GitHub Actions](https://github.com/actions/virtual-environments).
Expand Down
2 changes: 1 addition & 1 deletion docs/source/DevelopmentGuide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Ready to contribute to the project? Here is how to set up a local development en
Initial Setup
#############

1. Fork the `cda-tum/qecc <https://github.com/cda-tum/qecc>`_ repository on GitHub (see https://docs.github.com/en/get-started/quickstart/fork-a-repo).
1. Fork the `cda-tum/mqt-qecc <https://github.com/cda-tum/mqt-qecc>`_ repository on GitHub (see https://docs.github.com/en/get-started/quickstart/fork-a-repo).

2. Clone your fork locally

Expand Down
2 changes: 1 addition & 1 deletion docs/source/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ In order to get the best performance out of QECC and enable platform-specific co
This requires a `C++ compiler <https://en.wikipedia.org/wiki/List_of_compilers#C++_compilers>`_ compiler supporting *C++17* and a minimum `CMake <https://cmake.org/>`_ version of *3.19*.

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 `qecc/actions/workflows/ci.yml <https://github.com/cda-tum/qecc/actions/workflows/ci.yml>`_.
In order to access the latest build logs, visit `qecc/actions/workflows/ci.yml <https://github.com/cda-tum/mqt-qecc/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>`_.
8 changes: 1 addition & 7 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
Welcome to QECC's documentation
================================

QECC is a tool for quantum error correcting codes 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>`_.
QECC is a tool for quantum error correcting codes 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>`.
Then proceed to read the :doc:`reference documentation <library/Library>`.
Expand Down Expand Up @@ -46,7 +44,3 @@ please let us know at our :doc:`Support <Support>` page or by reaching out to us
:glob:

library/Library

----

.. rubric:: Footnotes
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ dev = ["mqt.qecc[coverage, docs, visualization]"]
"mqt.qecc.cc-decoder-plot" = "mqt.qecc.cc_decoder.plots:main"

[project.urls]
Homepage = "https://github.com/cda-tum/qecc"
Documentation = "https://github.com/cda-tum/qecc"
"Bug Tracker" = "https://github.com/cda-tum/qecc/issues"
Discussions = "https://github.com/cda-tum/qecc/discussions"
Homepage = "https://github.com/cda-tum/mqt-qecc"
Documentation = "https://github.com/cda-tum/mqt-qecc"
"Bug Tracker" = "https://github.com/cda-tum/mqt-qecc/issues"
Discussions = "https://github.com/cda-tum/mqt-qecc/discussions"

[tool.setuptools.packages.find]
include = ["mqt.*"]
Expand Down
Loading