Skip to content

UST-QuAntiL/circuit-cutting-service

Repository files navigation

Circuit Cutting Service

Tests passed License Code style: black

The circuit cutting service enables the partioning of quantum circuits into smaller sub-circuits, such that circuits whose width exceeds a quantum computers number of qubits can still be executed. Moveover, the circuit depth of the sub-circuits is smaller, making them less prone to computational errors.

Running the Service

The easiest way to get start is using a pre-built Docker image:

docker run -p 5076:5076 planqk/circuit-cutting-service

Alternatively, the service can be built manually:

  1. Clone the repository using git clone https://github.com/UST-QuAntiL/circuit-cutting-service.git
  2. Navigate to the corresponding folder within the cloned repository cd Quokka/services/circuit-cutting-service
  3. Build the Docker container: docker build -t circuit-cutting-service .
  4. Run the Docker container: docker run -p 5076:5076 circuit-cutting-service

Then the service can be accessed via: http://127.0.0.1:5076.

API Documentation

The circuit cutting service provides a Swagger UI, specifying the request schemas and showcasing exemplary requests for all API endpoints.

Developer Guide

Setup (exemplary for ubuntu 18.04):

git clone https://github.com/UST-QuAntiL/Quokka.git
cd Quokka/services/circuit-cutting-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

Execution:

  • Run the application with: flask run --port=5076
  • Test with: python -m unittest discover
  • Coverage with: coverage run --branch --include 'app/*' -m unittest discover; coverage report

Codestyle:

black . OR black FILE|DIRECTORY

Disclaimer of Warranty

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.

Haftungsausschluss

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.

Acknowledgements

The initial code contribution has been supported by the project SEQUOIA funded by the Baden-Wuerttemberg Ministry of the Economy, Labour and Housing.