:py:mod:`pygsti.circuits.rpecircuits`
=====================================

.. py:module:: pygsti.circuits.rpecircuits

.. autoapi-nested-parse::

   Functions for creating circuit lists






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


Functions
~~~~~~~~~

.. autoapisummary::

   pygsti.circuits.rpecircuits.make_rpe_alpha_str_lists_gx_gz
   pygsti.circuits.rpecircuits.make_rpe_epsilon_str_lists_gx_gz
   pygsti.circuits.rpecircuits.make_rpe_theta_str_lists_gx_gz
   pygsti.circuits.rpecircuits.make_rpe_string_list_d



.. py:function:: make_rpe_alpha_str_lists_gx_gz(k_list)

   Make alpha cosine and sine circuit lists for (approx) X pi/4 and Z pi/2 gates.

   These circuits are used to estimate alpha (Z rotation angle).

   Parameters
   ----------
   k_list : list of ints
       The list of "germ powers" to be used.  Typically successive powers of
       two; e.g. [1,2,4,8,16].

   Returns
   -------
   cosStrList : list of Circuits
       The list of "cosine strings" to be used for alpha estimation.
   sinStrList : list of Circuits
       The list of "sine strings" to be used for alpha estimation.


.. py:function:: make_rpe_epsilon_str_lists_gx_gz(k_list)

   Make epsilon cosine and sine circuit lists for (approx) X pi/4 and Z pi/2 gates.

   These circuits are used to estimate epsilon (X rotation angle).

   Parameters
   ----------
   k_list : list of ints
       The list of "germ powers" to be used.  Typically successive powers of
       two; e.g. [1,2,4,8,16].

   Returns
   -------
   epsilonCosStrList : list of Circuits
       The list of "cosine strings" to be used for epsilon estimation.
   epsilonSinStrList : list of Circuits
       The list of "sine strings" to be used for epsilon estimation.


.. py:function:: make_rpe_theta_str_lists_gx_gz(k_list)

   Make theta cosine and sine circuit lists for (approx) X pi/4 and Z pi/2 gates.

   These circuits are used to estimate theta (X-Z axes angle).

   Parameters
   ----------
   k_list : list of ints
       The list of "germ powers" to be used.  Typically successive powers of
       two; e.g. [1,2,4,8,16].

   Returns
   -------
   thetaCosStrList : list of Circuits
       The list of "cosine strings" to be used for theta estimation.
   thetaSinStrList : list of Circuits
       The list of "sine strings" to be used for theta estimation.


.. py:function:: make_rpe_string_list_d(log2k_max)

   Creates a dictionary containing all the circuits needed for RPE.

   This includes circuits for all RPE cosine and sine experiments for all three angles.

   Parameters
   ----------
   log2k_max : int
       Maximum number of times to repeat an RPE "germ"

   Returns
   -------
   totalStrListD : dict
       A dictionary containing all circuits for all sine and cosine
       experiments for alpha, epsilon, and theta.
       The keys of the returned dictionary are:

       - 'alpha','cos' : List of circuits for cosine experiments used
         to determine alpha.
       - 'alpha','sin' : List of circuits for sine experiments used to
         determine alpha.
       - 'epsilon','cos' : List of circuits for cosine experiments used to
          determine epsilon.
       - 'epsilon','sin' : List of circuits for sine experiments used to
         determine epsilon.
       - 'theta','cos' : List of circuits for cosine experiments used to
         determine theta.
       - 'theta','sin' : List of circuits for sine experiments used to
         determine theta.
       - 'totalStrList' : All above circuits combined into one list;
         duplicates removed.