# Client

Source: https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client

The Boulder Opal Scale Up Client provides a Python interface for interacting with
Q-CTRL’s Boulder Opal Scale Up hardware and cloud services.

Use boulderopalscaleup.QctrlScaleUpClient to manage devices, run experiments and routines,
and retrieve data.

## Classes

|||
|----------------------------------------------------------------------------------------------|---------------------------------------------------------------|
| [QctrlScaleUpClient](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/QctrlScaleUpClient.md#boulderopalscaleup.QctrlScaleUpClient)   | Q-CTRL Scale Up client providing API access to experiments.   |

## QctrlScaleUpClient methods

|||
|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| [create_device](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/create_device.md#boulderopalscaleup.QctrlScaleUpClient.create_device)                                           | Create and initialize a device for experiments.                                                                                |
| [display](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/display.md#boulderopalscaleup.QctrlScaleUpClient.display)                                                             | Display data in a formatted table or plot.                                                                                     |
| [display_device_data_sheet](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/display_device_data_sheet.md#boulderopalscaleup.QctrlScaleUpClient.display_device_data_sheet)       | Display a data sheet of the components in the device.                                                                          |
| [enable_all_qubits](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/enable_all_qubits.md#boulderopalscaleup.QctrlScaleUpClient.enable_all_qubits)                               | Enable all qubits for running experiments.                                                                                     |
| [enable_qubits](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/enable_qubits.md#boulderopalscaleup.QctrlScaleUpClient.enable_qubits)                                           | Enable specified elements for running experiments.                                                                             |
| [get_defcal_info](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/get_defcal_info.md#boulderopalscaleup.QctrlScaleUpClient.get_defcal_info)                                     | Get pulse information for a certain defined calibration.                                                                       |
| [get_device_calibration_data](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/get_device_calibration_data.md#boulderopalscaleup.QctrlScaleUpClient.get_device_calibration_data) | Get structured calibration data for a device.                                                                                  |
| [get_device_data](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/get_device_data.md#boulderopalscaleup.QctrlScaleUpClient.get_device_data)                                     | Get latest data for a device.                                                                                                  |
| [get_device_summary](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/get_device_summary.md#boulderopalscaleup.QctrlScaleUpClient.get_device_summary)                            | Retrieve the summary of a device.                                                                                              |
| [get_devices](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/get_devices.md#boulderopalscaleup.QctrlScaleUpClient.get_devices)                                                 | Retrieve a summary for all devices.                                                                                            |
| [get_job_data](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/get_job_data.md#boulderopalscaleup.QctrlScaleUpClient.get_job_data)                                              | Retrieves details about a specific job executed on the device, such as its status, execution results, and associated metadata. |
| [get_jobs](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/get_jobs.md#boulderopalscaleup.QctrlScaleUpClient.get_jobs)                                                          | Retrieves all the jobs that have been previously executed on the given device.                                                 |
| [load_device_snapshot](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/load_device_snapshot.md#boulderopalscaleup.QctrlScaleUpClient.load_device_snapshot)                      | Sets the state of a device by applying a snapshot obtained from save_device_snapshot.                                          |
| [run](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/run.md#boulderopalscaleup.QctrlScaleUpClient.run)                                                                         | Execute an experiment, a routine, or a solution.                                                                               |
| [save_device_snapshot](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/save_device_snapshot.md#boulderopalscaleup.QctrlScaleUpClient.save_device_snapshot)                      | Save a snapshot of a device.                                                                                                   |
| [set_current_device](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/set_current_device.md#boulderopalscaleup.QctrlScaleUpClient.set_current_device)                            | Set which device to use in routines and experiments.                                                                           |
| [set_runtime](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/set_runtime.md#boulderopalscaleup.QctrlScaleUpClient.set_runtime)                                                 | Set the runtime after initialization.                                                                                          |
| [update_device](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/update_device.md#boulderopalscaleup.QctrlScaleUpClient.update_device)                                           | Update the current device's processor information.                                                                             |
| [update_frame](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/update_frame.md#boulderopalscaleup.QctrlScaleUpClient.update_frame)                                              | Update the frequency of a frame on the device.                                                                                 |
| [update_frames](https://docs.q-ctrl.com/references/boulder-opal-scale-up/boulderopalscaleup/client/update_frames.md#boulderopalscaleup.QctrlScaleUpClient.update_frames)                                           | Update the frequencies of multiple frames on the device.                                                                       |
