Quickstart

A crash course on using the PlanQK Platform to run an entire quantum workflow, from development to deployment 🚀.

Installation

Create an account

If you don't have one yet, create an account

Install the PlanQK CLI

To install the PlanQK CLI, you must install Node.js 18 or higher and the npm command line interface using either a Node version manager or a Node installer.

Then install the PlanQK CLI globally using npm:

npm install -g @planqk/planqk-cli

IMPORTANT

Make sure you have uninstalled the deprecated CLI:

npm uninstall -g @anaqor/planqk

For details read the CLI reference.

Login to your account

• Copy your personal access token to your clipboard.
• Login to your account using your access token:

planqk login -t <your access token>

Create your first project

Create your first project by running the following command:

planqk init

You will be prompted to provide some information about your project configuration. For this quickstart, select the following configuration:

• Name: my-project
• Template: IonQ Starter (Azure Quantum)
• vCPU: 0.5 vCPU
• Memory: 1GB

TIP

Access to IonQ's quantum simulator is available in basic accounts. At least a Pro account is required, if you want to use IonQ QPUs or other quantum hardware.

This will create a new directory called my-project containing all required files to run your quantum code on the PlanQK Platform. The starter templates implement quantum random number generation using either the IonQ Simulator or the Qiskit Aer Simulator. You can find a detailed description of the templates in this GitLab repository. It also contains a planqk.json file, which contains the project configuration. The file should look like this:

{
  "name": "my-project",
  "description": "<your project description>",
  "resources": {
    "cpu": 0.5,
    "memory": 1
  },
  "runtime": "PYTHON_TEMPLATE"
}

Test your service locally

Let's test your service locally before deploying it to the PlanQK Platform. First, switch to your project directory:

cd my-project

Then, install the required dependencies. We recommend using a dedicated Conda environment. As an alternative, you can use the requirements.txt to install the dependencies with the tooling of your choice.

With conda run:

conda env create -f environment.yml
conda activate my-project

Finally, run your service locally:

python -m src

The output should look like this:

{
  "result": {
    "random_number": 216
  },
  "metadata": {
    "execution_time": 9.327
  }
}

Test your service locally with PlanQK CLI

To begin, navigate to your project directory:

cd my-project

Next, run the following command:

planqk serve

Once the server is operational, you can access http://localhost:8081/docs. This interface provides you the ability to manage service executions via the API. Further information can be found in the documentation.

Deploy your service

Deploy your service to the PlanQK Platform. Within your project directory, run:

planqk up

This will build your service, deploy it, and make it accessible to you via a REST API.

Execute your service

Execute your service with the example input data by running the following command:

planqk run

After a successful execution, the output should look like this:

Running Job (a7a3422b-9522-408b-96c9-32cdb497b12b)... Job succeeded.
See result at https://platform.planqk.de/jobs/a7a3422b-9522-408b-96c9-32cdb497b12b

As a default, the input data and params are read from the input.json and params.json file contained in the input directory in your project.

You can also provide the input data and params as command line flags:

planqk run -d '{"values": [10,12]}' -p '{"round_up": true}'

For more details and options see the CLI reference.

What's next?

code

Get Started with our SDK

Learn how to use our SDK to interact with our supported quantum backends.play_arrow

Deep Dive into Jobs

Learn everything about Jobs and how to use them.

Custom Docker Images

Run your own Docker images on the platform.school

Explore our Tutorials

Check out our tutorials to get started with the platform.