:py:mod:`pygsti.models.rpemodel`
================================

.. py:module:: pygsti.models.rpemodel

.. autoapi-nested-parse::

   Functions for creating RPE Models






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


Functions
~~~~~~~~~

.. autoapisummary::

   pygsti.models.rpemodel.make_rpe_model
   pygsti.models.rpemodel.rpe_ensemble_test



.. py:function:: make_rpe_model(alpha_true, epsilon_true, y_rot, spam_depol, gate_depol=None, with_id=True)

   Make a model for simulating RPE, paramaterized by rotation angles.

   Note that the output model also has thetaTrue, alpha_true, and epsilon_true
   added attributes.

   Parameters
   ----------
   alpha_true : float
       Angle of Z rotation (canonical RPE requires alpha_true to be close to
       pi/2).

   epsilon_true : float
       Angle of X rotation (canonical RPE requires epsilon_true to be close to
       pi/4).

   y_rot : float
       Angle of rotation about Y axis that, by similarity transformation,
       rotates X rotation.

   spam_depol : float
       Amount to depolarize SPAM by.

   gate_depol : float, optional
       Amount to depolarize gates by (defaults to None).

   with_id : bool, optional
       Do we include (perfect) identity or no identity? (Defaults to False;
       should be False for RPE, True for GST)

   Returns
   -------
   Model
       The desired model for RPE; model also has attributes thetaTrue,
       alpha_true, and epsilon_true, automatically extracted.


.. py:function:: rpe_ensemble_test(alpha_true, epsilon_true, y_rot, spam_depol, log2k_max, n, runs)

   Experimental test function