Remove new_predefined_dds (#125)

Author: tachikoma-li

examples/creating-a-driven-control.ipynb

@@ -380,7 +380,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.3"
+   "version": "3.6.4"
   },
   "toc": {
    "base_numbering": 1,
@@ -397,5 +397,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

examples/creating-a-dynamical-decoupling-sequence.ipynb

@@ -40,7 +40,6 @@
     new_carr_purcell_sequence,
     new_cpmg_sequence,
     new_periodic_sequence,
-    new_predefined_dds,
     new_quadratic_sequence,
     new_ramsey_sequence,
     new_spin_echo_sequence,
@@ -60,7 +59,6 @@
     "new_corpse_in_scrofulous_control",
     "new_corpse_in_sk1_control",
     "new_modulated_gaussian_control",
-    "new_predefined_dds",
     "new_predefined_driven_control",
     "new_primitive_control",
     "new_scrofulous_control",

qctrlopencontrols/__init__.py

@@ -77,33 +77,3 @@
 
 # Matplotlib format of data for plotting
 MATPLOTLIB = "matplotlib"
-
-# Ramsey sequence
-RAMSEY = "Ramsey"
-
-# Spin echo (SE) dynamical decoupling sequence
-SPIN_ECHO = "spin echo"
-
-# Carr-Purcell (CP) dynamical decoupling sequence
-CARR_PURCELL = "Carr-Purcell"
-
-# Carr-Purcell-Meiboom-Gill (CPMG) dynamical decoupling sequence
-CARR_PURCELL_MEIBOOM_GILL = "Carr-Purcell-Meiboom-Gill"
-
-# Uhrig (single-axis) dynamical decoupling sequence
-UHRIG_SINGLE_AXIS = "Uhrig single-axis"
-
-# Periodical dynamical decoupling sequence
-PERIODIC_SINGLE_AXIS = "periodic single-axis"
-
-# Walsh dynamical decoupling sequence
-WALSH_SINGLE_AXIS = "Walsh single-axis"
-
-# Quadratic dynamical decoupling sequence
-QUADRATIC = "quadratic"
-
-# X-Concatenated dynamical decoupling sequence
-X_CONCATENATED = "X concatenated"
-
-# XY-Concatenated dynamical decoupling sequence
-XY_CONCATENATED = "XY concatenated"

qctrlopencontrols/constants.py

@@ -23,18 +23,6 @@
 
 import numpy as np
 
-from ..constants import (
-    CARR_PURCELL,
-    CARR_PURCELL_MEIBOOM_GILL,
-    PERIODIC_SINGLE_AXIS,
-    QUADRATIC,
-    RAMSEY,
-    SPIN_ECHO,
-    UHRIG_SINGLE_AXIS,
-    WALSH_SINGLE_AXIS,
-    X_CONCATENATED,
-    XY_CONCATENATED,
-)
 from ..exceptions import ArgumentsValueError
 from .dynamic_decoupling_sequence import DynamicDecouplingSequence
 
@@ -160,86 +148,6 @@ def _add_pre_post_rotations(
     return offsets, rabi_rotations, azimuthal_angles, detuning_rotations
 
 
-def new_predefined_dds(scheme=SPIN_ECHO, **kwargs):
-    """
-    Creates a new instance of one of the predefined dynamic decoupling sequences.
-
-    Parameters
-    ----------
-    scheme : string
-        The name of the sequence. The available options are:
-
-        - 'Ramsey'
-        - 'spin echo'
-        - 'Carr-Purcell'
-        - 'Carr-Purcell-Meiboom-Gill'
-        - 'Uhrig single-axis'
-        - 'Periodic single-axis'
-        - 'Walsh single-axis'
-        - 'quadratic'
-        - 'X concatenated'
-        - 'XY concatenated'
-
-        Defaults to 'spin echo'.
-    kwargs : dict, optional
-        Additional keyword argument to create the sequence.
-
-    Returns
-    ------
-    qctrlopencontrols.dynamic_decoupling_sequences.DynamicDecouplingSequence
-        A dynamical decoupling sequence corresponding to `scheme`.
-
-    Raises
-    -----
-    ArgumentsValueError
-        Raised when an argument is invalid.
-    """
-
-    if scheme == RAMSEY:
-        sequence = new_ramsey_sequence(**kwargs)
-    elif scheme == SPIN_ECHO:
-        sequence = new_spin_echo_sequence(**kwargs)
-    elif scheme == CARR_PURCELL:
-        sequence = new_carr_purcell_sequence(**kwargs)
-    elif scheme == CARR_PURCELL_MEIBOOM_GILL:
-        sequence = new_cpmg_sequence(**kwargs)
-    elif scheme == UHRIG_SINGLE_AXIS:
-        sequence = new_uhrig_sequence(**kwargs)
-    elif scheme == PERIODIC_SINGLE_AXIS:
-        sequence = new_periodic_sequence(**kwargs)
-    elif scheme == WALSH_SINGLE_AXIS:
-        sequence = new_walsh_sequence(**kwargs)
-    elif scheme == QUADRATIC:
-        sequence = new_quadratic_sequence(**kwargs)
-    elif scheme == X_CONCATENATED:
-        sequence = new_x_concatenated_sequence(**kwargs)
-    elif scheme == XY_CONCATENATED:
-        sequence = new_xy_concatenated_sequence(**kwargs)
-    # Raise an error if the input sequence is not known
-    else:
-        raise ArgumentsValueError(
-            "Unknown predefined sequence scheme. Allowed schemes are: "
-            + ", ".join(
-                [
-                    RAMSEY,
-                    SPIN_ECHO,
-                    CARR_PURCELL,
-                    CARR_PURCELL_MEIBOOM_GILL,
-                    UHRIG_SINGLE_AXIS,
-                    PERIODIC_SINGLE_AXIS,
-                    WALSH_SINGLE_AXIS,
-                    QUADRATIC,
-                    X_CONCATENATED,
-                    XY_CONCATENATED,
-                ]
-            )
-            + ".",
-            {"sequence_name": scheme},
-        )
-
-    return sequence
-
-
 def _check_duration(duration: Optional[float] = None) -> float:
     """
     Validates sequence duration.