resources
=========

.. py:module:: quantify_scheduler.resources 

.. autoapi-nested-parse::

   Common resources for use with the quantify_scheduler.



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

Classes
~~~~~~~

.. autoapisummary::

   quantify_scheduler.resources.Resource
   quantify_scheduler.resources.ClockResource
   quantify_scheduler.resources.BasebandClockResource
   quantify_scheduler.resources.DigitalClockResource




.. py:class:: Resource(name: str)

   Bases: :py:obj:`collections.UserDict`


   A resource corresponds to a physical resource such as a port or a clock.

   .. jsonschema::

       {
           "type": "object",
           "description": "JSON schema for a quantify resource.",
           "additionalProperties": true,
           "required": [
               "name",
               "type"
           ],
           "properties": {
               "name": {
                   "type": "string",
                   "description": "Name of the resource."
               },
               "type": {
                   "type": "string",
                   "description": "Type of the resource, this property can be used by compilation steps."
               }
           }
       }



   :param name: The resource name.


   .. py:method:: is_valid(operation: Resource) -> bool
      :staticmethod:


      Validates the Resource against the schemas/resource.json fastjsonschema.

      :param operation: The operation to validate.

      :raises fastjsonschema.JsonSchemaException: if the instance is invalid
      :raises fastjsonschema.JsonSchemaDefinitionException: if the schema itself is invalid

      :returns: If the validation was successful.
      :rtype: bool



   .. py:property:: name
      :type: str

      Returns the name of the Resource.


   .. py:property:: hash
      :type: str

      A hash based on the contents of the Operation.


.. py:class:: ClockResource(name: str, freq: float, phase: float = 0)

   Bases: :py:obj:`Resource`


   The ClockResource corresponds to a physical clock used to modulate pulses.

   :param name: the name of this clock
   :param freq: the frequency of the clock in Hz
   :param phase: the starting phase of the clock in deg


   .. py:attribute:: data


.. py:class:: BasebandClockResource(name: str)

   Bases: :py:obj:`Resource`


   Global identity for a virtual baseband clock.

   Baseband signals are assumed to be real-valued and will not be modulated.

   :param name: the name of this clock


   .. py:attribute:: IDENTITY
      :value: 'cl0.baseband'



   .. py:attribute:: data


.. py:class:: DigitalClockResource(name: str)

   Bases: :py:obj:`Resource`


   Global identity for a virtual digital clock.

   Digital clocks can only be associated with digital channels.

   :param name: the name of this clock


   .. py:attribute:: IDENTITY
      :value: 'digital'



   .. py:attribute:: data