compiler_container
==================

.. py:module:: quantify_scheduler.backends.qblox.compiler_container 

.. autoapi-nested-parse::

   Contains the compiler container class.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   quantify_scheduler.backends.qblox.compiler_container.CompilerContainer




.. py:class:: CompilerContainer(schedule: quantify_scheduler.Schedule)


   Container class that holds all the compiler objects for the individual instruments.

   This class serves to allow all the possible compilation steps that involve multiple
   devices at the same time, such as calculating the modulation frequency for a device
   with a separate local oscillator from a clock that is defined at the schedule level.

   It is recommended to construct this object using the ``from_hardware_cfg`` factory
   method.


   :param schedule: The schedule to be compiled.

   .. py:attribute:: total_play_time

      The total duration of the schedule in absolute time this class will be
      compiling.

   .. py:attribute:: resources

      The resources attribute of the schedule. Used for getting the information
      from the clocks.

   .. py:attribute:: instrument_compilers
      :type: Dict[str, quantify_scheduler.backends.qblox.compiler_abc.InstrumentCompiler]

      The compilers for the individual instruments.

   .. py:attribute:: generics
      :type: Set[str]

      Set of generic instruments in the setup.

   .. py:method:: prepare()

      Prepares all the instrument compilers contained in the class,
      by running their respective :code:`prepare` methods.


   .. py:method:: compile(debug_mode: bool, repetitions: int) -> Dict[str, Any]

      Performs the compilation for all the individual instruments.

      :param debug_mode: Debug mode can modify the compilation process,
                         so that debugging of the compilation process is easier.
      :param repetitions: Amount of times to perform execution of the schedule.

      :returns: Dictionary containing all the compiled programs for each instrument. The key
                refers to the name of the instrument that the program belongs to.


   .. py:method:: add_instrument_compiler(name: str, instrument_type: Union[str, type], instrument_cfg: Dict[str, Any], latency_corrections: Optional[Dict[str, float]] = None) -> None

      Adds an instrument compiler to the container.

      :param name: Name of the instrument.
      :param instrument_type: A reference to the compiler class. Can either be passed as string or a
                              direct reference.
      :param instrument_cfg: The hardware config dict for this specific instrument.
      :param latency_corrections: Dict containing the delays for each port-clock combination. This is
                                  specified in the top layer of hardware config.


   .. py:method:: from_hardware_cfg(schedule: quantify_scheduler.Schedule, hardware_cfg: dict) -> CompilerContainer
      :classmethod:

      Factory method for the CompilerContainer. This is the preferred way to use the
      CompilerContainer class.

      :param schedule: The schedule to pass to the constructor.
      :param hardware_cfg: The hardware config.