.. _cluster_api:

Cluster API
===========

The Cluster driver is separated into three layers:

- :ref:`cluster_qcodes`: Instrument driver based on `QCoDeS <https://microsoft.github.io/Qcodes/>`_ and the instrument's native interface.

- :ref:`cluster_native`: Instrument API that provides control over the instrument and is an extension of the the SCPI interface.

- :ref:`cluster_scpi`: Instrument API based on the `SCPI <https://www.ivifoundation.org/downloads/SCPI/scpi-99.pdf>`_ standard which in turn is based on IEEE488.2.

.. _cluster_qcodes:

QCoDeS driver
-------------

.. autoclass:: qblox_instruments.Cluster


QCoDeS instrument parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

`QCoDeS <https://microsoft.github.io/Qcodes/>`_ parameters generated by :class:`~qblox_instruments.Cluster`.

.. include:: ../_build/cluster_param.rst
.. include:: ../_build/methods_cluster_param.rst


QCoDeS module parameters
^^^^^^^^^^^^^^^^^^^^^^^^

Besides instrument parameters, the Cluster also has parameters for each module in the Cluster which are
described in :doc:`/api_reference/module`.

.. _cluster_native:

Native interface
----------------

.. autoclass:: qblox_instruments.native.Cluster

.. _cluster_scpi:

SCPI interface
--------------

.. autoclass:: qblox_instruments.scpi.Cluster


Supporting classes and functions
--------------------------------

Please have a look at:
 - :doc:`/api_reference/module`
 - :doc:`/api_reference/sequencer`
 - :doc:`/api_reference/generic_func`
 - :doc:`/api_reference/ieee488_2`
 - :doc:`/api_reference/instrument_types`