Quantum computing - Getting started with Emulators Notebooks

Introduction

A Notebook is a document that integrates code, rich text elements, and multimedia, making it a convenient tool for quantum analysis and visualization.

OVHcloud Quantum Emulators is our managed solution for Jupyter and VS Code Notebooks. You can easily launch Notebooks with the required CPU and GPU resources while enjoying benefits like pre-installed dependencies and Quantum frameworks, secure user access, and simplified data management.

Objective

This guide demonstrates how to create, configure, access, stop, restart and delete a Quantum Emulators Notebook from the OVHcloud Control Panel (UI). This method is user-friendly and ideal for beginners.

Alternatively, you can use one of the following methods:

• The ovhai command-line interface (CLI)
• The Quantum API
• The ovhai Python SDK

Each method offers its distinct advantages, depending on your expertise and preferred workflow.

Requirements

• A Public Cloud project in your OVHcloud account.
• Access to the OVHcloud Control Panel.
• A Public Cloud user with the Administrator or Quantum Operator & Objectstore Operator roles.

Instructions

OVHcloud Quantum Solutions authorization process

If you're using the CLI, API, or SDK, you will need to complete an authorization process before creating a Quantum Emulators Notebook. To do so, follow these steps:

1. Log in to the OVHcloud Control Panel and navigate to the Public Cloud section.
2. Select the Public Cloud project you want to use and click the Quantum Emulators category.
3. Click the Create a Notebook button. The authorization process will take place silently in the background.

Launch your first Quantum Notebook

To create a Quantum Notebook, follow these steps:

from ovhai import AuthenticatedClient
from ovhai.api.notebook import notebook_new
from ovhai.models import NotebookSpec, Notebook
from ovhai.ovhai_types import Response

client = AuthenticatedClient(
base_url="https://gra.ai.cloud.ovh.net",
token="YOUR_QUANTUM_TOKEN",
)

# Define notebook parameters
editor_id = "jupyterlab"
framework_id = "alicebob"
framework_version = "1.2.0-py312-cpu"
nb_cpu = 1

# Create the notebook creation request
notebook_specs = {
"env": {"editorId": editor_id, "frameworkId": framework_id, "frameworkVersion": framework_version},
"resources": {"cpu": nb_cpu},
}

with client as client:
response: Response[Notebook] = notebook_new.sync_detailed(
client=client, body=NotebookSpec.from_dict(notebook_specs)
)

import json
response_content = response.content.decode('utf-8')  # Decode bytes to a string
response_dict = json.loads(response_content)

status_code = response.status_code
id_ = response_dict['id']
spec = response_dict['spec']
status = response_dict['status']
state = status['state']
info = status['info']
url = response_dict['status']['url']

print(f"Status code: {status_code}")
print(f"ID: {id_}")
print(f"Spec: {spec}")
print(f"State: {state}")
print(f"Info: {info}")
print(f"URL: {url}")

Once your Quantum Notebook is created and running, you can access it using the JupyterLab link in the Quantum Notebooks board or through the ovhai CLI, Quantum API, or Python SDK.

from ovhai.api.notebook import notebook_get_all
from ovhai.models import NotebookList
from ovhai.ovhai_types import Response

from ovhai import AuthenticatedClient

client = AuthenticatedClient(
base_url="https://gra.ai.cloud.ovh.net",
token="YOUR_QUANTUM_TOKEN",
)

with client as client:
response: Response[NotebookList] = notebook_get_all.sync_detailed(client=client)
import json
response = json.loads(response.content.decode())
for notebook_info in response["items"]:
print(f"ID: {notebook_info['id']}")
print(f"Name: {notebook_info['spec']['name']}")
print(f"Status: {notebook_info['status']['state']}")
print(f"Framework: {notebook_info['spec']['env']['frameworkId']}")
print(f"Framework version: {notebook_info['spec']['env']['frameworkVersion']}")
print(f"Editor: {notebook_info['spec']['env']['editorId']}")
print(f"Access link: {notebook_info['status']['url']}")
print("---------------")

from ovhai.api.notebook import notebook_get
from ovhai import AuthenticatedClient
import json

client = AuthenticatedClient(
base_url="https://gra.ai.cloud.ovh.net",
token="YOUR_QUANTUM_TOKEN",
)
id = "YOUR_NOTEBOOK_UUID"

with client as client:
response = notebook_get.sync_detailed(
id=id, client=client
)

print(json.loads(response.content.decode()))

To connect to your Quantum Notebook, you'll need to authenticate using a username and password combination or an access token.

Using a Username and Password

Enter your Public Cloud project user's credentials to log in to your Quantum Notebook.

Using an Access Token

Click the Login with token button and enter your access token to log in to your Quantum Notebook.

Stopping a Quantum Notebook

You can stop your Quantum Notebook at any time to release its compute resources. This will release its compute resources but will keep your Notebook data and installed libraries. Therefore, you will not incur any further charges for compute unless you restart the Notebook. However, attached storage will be billed at the price of OVHcloud Object Storage (consult the Quantum Notebooks Billing documentation for more information). To do so, follow these steps:

from ovhai.api.notebook import notebook_stop
from ovhai import AuthenticatedClient
client = AuthenticatedClient(
base_url="https://gra.ai.cloud.ovh.net",
token="YOUR_QUANTUM_TOKEN",
)
id = "YOUR_NOTEBOOK_UUID"

with client as client:
response = notebook_stop.sync_detailed(client=client, id=id)

To restart a stopped Notebook, follow these steps:

from ovhai.api.notebook import notebook_start
from ovhai import AuthenticatedClient
client = AuthenticatedClient(
base_url="https://gra.ai.cloud.ovh.net",
token="YOUR_QUANTUM_TOKEN",
)
id = "YOUR_NOTEBOOK_UUID"

with client as client:
response = notebook_start.sync_detailed(
id=id, client=client
)

The notebook must be stopped before deleting it. To delete a Notebook, follow these steps:

from ovhai.api.notebook import notebook_delete
from ovhai import AuthenticatedClient

client = AuthenticatedClient(
base_url="https://gra.ai.cloud.ovh.net",
token="YOUR_QUANTUM_TOKEN",
)
id = "YOUR_NOTEBOOK_UUID"

with client as client:
response = notebook_delete.sync_detailed(
id=id, client=client, force=False
)

print(response.content.decode())

• Discover how to access your Object Storage data and Git repositories from your Notebooks using the UI here.
• Learn about the technical features, capabilities, and limitations of the Public Cloud Quantum Notebooks offering here.
• Get some hints on how to debug your Notebooks if things go wrong here.

If you need training or technical assistance to implement our solutions, contact your sales representative or click on this link to get a quote and ask our Professional Services experts for a custom analysis of your project.

Feedback

We would love to help answer questions and appreciate any feedback you may have.

Please send us your questions, feedback, and suggestions regarding Quantum Notebooks:

• In the #quantum-computing channel of the OVHcloud Discord server.