cirq_superstaq.serialization
============================

.. py:module:: cirq_superstaq.serialization


Attributes
----------

.. autoapisummary::

   cirq_superstaq.serialization.SUPERSTAQ_RESOLVERS


Functions
---------

.. autoapisummary::

   cirq_superstaq.serialization.deserialize_circuits
   cirq_superstaq.serialization.deserialize_qiskit_circuits
   cirq_superstaq.serialization.serialize_circuits


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

.. py:function:: deserialize_circuits(serialized_circuits: str) -> list[cirq.Circuit]

   Deserialize serialized circuit(s).

   :param serialized_circuits: A json string generated via `serialization.serialize_circuit()`.

   :returns: The circuit or list of circuits that was serialized.


.. py:function:: deserialize_qiskit_circuits(serialized_qiskit_circuits: str, circuits_is_list: bool, pulse_start_times: collections.abc.Sequence[collections.abc.Sequence[int]] | None = None) -> list[object] | None

   Deserializes `qiskit.QuantumCircuit` objects, if possible; otherwise warns the user.

   :param serialized_qiskit_circuits: Qiskit circuits serialized via `qiskit_superstaq.serialize_circuits()`.
   :param circuits_is_list: Whether to refer to "circuits" (plural) or "circuit" (singular) in warning
                            messages.
   :param pulse_start_times: A list of lists of start times, where each list contains the start times
                             of every op in the corresponding (serialized) circuit.

   :returns: A list of deserialized `qiskit.QuantumCircuit` objects, or None if the provided circuits
             could not be deserialized.


.. py:function:: serialize_circuits(circuits: cirq.AbstractCircuit | collections.abc.Sequence[cirq.AbstractCircuit]) -> str

   Serialize circuit(s) into a json string.

   :param circuits: A `cirq.Circuit` or list of `cirq.Circuits` to be serialized.

   :returns: A string representing the serialized circuit(s).


.. py:data:: SUPERSTAQ_RESOLVERS