System information
==================

QPU execution estimates
~~~~~~~~~~~~~~~~~~~~~~~~~
If you want to know when a task is likely to be executed on a particular QPU, you can supply a list of QPU ids to query.
For each valid QPU id, you will receive an estimated availability time, queue length, and a list of upcoming windows.

.. code-block:: python

    command: client.get_qpu_execution_estimates(qpu_ids=<qpu_id>)
    example response:
    {
        'qpu_wait_times':
            [
                {
                    'estimated_availability_time': '2023-08-16T11:18:01.680Z',
                    'qpu_id': '<qpu_id>',
                    'tasks_in_queue': 20,
                    'timestamp': '2023-08-16T11:18:01.680Z',
                    'windows':
                    [
                        {
                            'end_time': '2023-08-16T11:18:01.680Z',
                            'start_time': '2023-08-16T11:18:01.680Z',
                            'window_description': 'CURRENT'
                        }
                    ]
                }
            ]
    }

Window information
~~~~~~~~~~~~~~~~~~~~~~~~~
The scheduling of tasks varies by customer and QPU. The task queuing system orchestrates your access depending on a your
subscription with OQC. Each task you submit is scheduled to run on a given window of time, henceforth referred to as
window. You can query the next available window for the task using the following command.

.. code-block:: python

    client.get_next_window(qpu_id=<qpu_id>)

If a *None* is returned, there is no window scheduled for the task to be processed. Windows are set up internally so if
you experience this contact :ref:`cloud support team` to ensure that the task will be processed. Currently, the start
time of the next window is populated in the ‘start_time’ or  ‘starting’  fields, with the latter case marked for
deprecation soon.

Benchmarking information
~~~~~~~~~~~~~~~~~~~~~~~~~
You can access the benchmarking information, both the latest readings and historical data, of the QPUs available to you.
If you do not provide a QPU id, the query will default to the Lucy device. The following example shows you how to use
this command

.. code-block:: python

    client.get_calibration(qpu_id=<qpu_id>) # To get the latest calibration file
    client.get_calibration(qpu_id=<qpu_id>,date_filter =< "YYYY-MM-DD") # To get the calibration file of a given date

|