feat(doc): update readme

Author: vmscw

.github/workflows/test.yaml

@@ -38,6 +38,6 @@ jobs:
     - name: Run test
       run: pytest -s --showprogress -vv tests/
       env:
-        PULSER_SCALEWAY_PROJECT_ID: ${{ secrets.STG_PULSEr_SCALEWAY_PROJECT_ID }}
+        PULSER_SCALEWAY_PROJECT_ID: ${{ secrets.STG_PULSER_SCALEWAY_PROJECT_ID }}
         PULSER_SCALEWAY_SECRET_KEY: ${{ secrets.STG_PULSER_SCALEWAY_API_TOKEN }}
         PULSER_SCALEWAY_API_URL: ${{ secrets.STG_PULSER_SCALEWAY_API_URL }}

README.md

@@ -16,19 +16,18 @@ pip install pulser-scaleway
 
 ## Getting started
 
-To instantiate the `ScalewayQuantumService`, you need to have an access token and a project_id
+To instantiate the `ScalewayProvider`, you need to have an access token and a project_id
 
 ```python
-from pulser_scaleway import ScalewayQuantumService
+from pulser_scaleway import ScalewayProvider
 
-qaas_connection = ScalewayQuantumService(
+qaas_connection = ScalewayProvider(
     project_id=os.environ["PULSER_SCALEWAY_PROJECT_ID"],
     secret_key=os.environ["PULSER_SCALEWAY_SECRET_KEY"],
-    url=os.getenv("PULSER_SCALEWAY_API_URL"),
 )
 ```
 
-Alternatively, the `ScalewayQuantumService` can discover your access token from environment variables:
+Alternatively, the `ScalewayProvider` can discover your access token from environment variables:
 
 ```
 export PULSER_SCALEWAY_PROJECT_ID="project_id"
@@ -38,9 +37,9 @@ export PULSER_SCALEWAY_SECRET_KEY="token"
 Then you can instantiate the provider without any arguments:
 
 ```python
-from pulser_scaleway import ScalewayQuantumService
+from pulser_scaleway import ScalewayProvider
 
-qaas_connection = ScalewayQuantumService()
+qaas_connection = ScalewayProvider()
 ```
 
 Now you have access to the supported backends and can design your pulse sequence. [See the technical documentation](https://docs.pasqal.com/cloud/first-job/) on how to write a sequence.

examples/.keepit

@@ -0,0 +1,53 @@
+# Copyright 2025 Scaleway
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.from typing import Optional, List, Dict
+import os
+import numpy as np
+
+from pulser import Pulse, Sequence, BlackmanWaveform, RampWaveform
+from pulser.backend import QPUBackend
+from pulser.register import Register
+
+from pulser_scaleway import ScalewayProvider
+
+
+qaas_connection = ScalewayProvider(
+    project_id=os.environ["PULSER_SCALEWAY_PROJECT_ID"],
+    secret_key=os.environ["PULSER_SCALEWAY_SECRET_KEY"],
+)
+
+platform = "pasqal_fresnel_simulation"
+
+devices = qaas_connection.fetch_available_devices()
+fresnel_device = devices[platform]
+register = Register.square(5, 5).with_automatic_layout(fresnel_device)
+sequence = Sequence(register, fresnel_device)
+
+sequence.declare_channel("rydberg_global", "rydberg_global")
+t = sequence.declare_variable("t", dtype=int)
+
+amp_wf = BlackmanWaveform(t, np.pi)
+det_wf = RampWaveform(t, -5, 5)
+sequence.add(Pulse(amp_wf, det_wf, 0), "rydberg_global")
+
+backend = QPUBackend(sequence=sequence, connection=qaas_connection)
+
+results = backend.run(
+    job_params=[
+        {"runs": 100, "variables": {"t": 1000}},
+        {"runs": 20, "variables": {"t": 2000}},
+    ],
+    wait=True,
+)
+
+print(results.results)

examples/run_fresnel_device.py

@@ -11,5 +11,4 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from .scaleway_service import ScalewayQuantumService
-from .scaleway_backend import ScalewayBackend
+from .scaleway_service import ScalewayProvider

pulser_scaleway/__init__.py

@@ -42,8 +42,8 @@
 _DEFAULT_FETCH_INTERVAL = 2  # in second
 
 
-class ScalewayQuantumService(RemoteConnection):
-    """Sacleway Quantum as a Service connection bridge
+class ScalewayProvider(RemoteConnection):
+    """Sacleway Quantum as a Service connection bridge.
 
     :param project_id: optional UUID of the Scaleway Project, if the provided ``project_id`` is None, the value is loaded from the PULSER_SCALEWAY_PROJECT_ID environment variables
 

pulser_scaleway/scaleway_service.py

@@ -19,17 +19,17 @@
 from pulser.backend.remote import BatchStatus
 from pulser.register import Register
 
-from pulser_scaleway import ScalewayQuantumService
+from pulser_scaleway import ScalewayProvider
 
 
 def test_simple():
-    qaas_connection = ScalewayQuantumService(
+    qaas_connection = ScalewayProvider(
         project_id=os.environ["PULSER_SCALEWAY_PROJECT_ID"],
         secret_key=os.environ["PULSER_SCALEWAY_SECRET_KEY"],
         url=os.getenv("PULSER_SCALEWAY_API_URL"),
     )
 
-    platform = "pasqal_fresnel"
+    platform = "pasqal_fresnel_simulation"
 
     devices = qaas_connection.fetch_available_devices()
     fresnel_device = devices[platform]