The error-correction service the application of error correction codes to circuits, enabling the computation of fault-tolerant circuits. Currently, the error correction codes provided by QECC are supported.
The easiest way to get start is using a pre-built Docker image:
docker run -p 5078:5078 planqk/error-correction-service
Alternatively, the service can be built manually:
- Clone the repository using
git clone https://github.com/UST-QuAntiL/error-correction-service.git - Navigate to the corresponding folder within the cloned repository
cd error-correction-service - Build the Docker container:
docker build -t error-correction-service . - Run the Docker container:
docker run -p 5078:5078 error-correction-service
Then the service can be accessed via: http://127.0.0.1:5078.
The error-correction service provides a Swagger UI, specifying the request schemas and showcasing exemplary requests for all API endpoints.
- Swagger UI: http://127.0.0.1:5078/api/swagger-ui.
git clone https://github.com/UST-QuAntiL/Quokka.git
cd error-correction-service
# if virtualenv is not installed
sudo -H pip install virtualenv
# create new virtualenv called 'venv'
virtualenv venv
# activate virtualenv; in Windows systems activate might be in 'venv/Scripts'
source venv/bin/activate
#install application requirements.
pip install -r requirements.txt- Run the application with:
flask run --port=5078 - Test with:
python -m unittest discover - Coverage with:
coverage run --branch --include 'app/*' -m unittest discover; coverage report
black . OR black FILE|DIRECTORY
Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
Dies ist ein Forschungsprototyp. Die Haftung für entgangenen Gewinn, Produktionsausfall, Betriebsunterbrechung, entgangene Nutzungen, Verlust von Daten und Informationen, Finanzierungsaufwendungen sowie sonstige Vermögens- und Folgeschäden ist, außer in Fällen von grober Fahrlässigkeit, Vorsatz und Personenschäden, ausgeschlossen.