Renamed C2 to Calibration

Author: nwittler

c3/main.py

@@ -13,7 +13,7 @@
 from c3.generator.generator import Generator
 
 from c3.optimizers.optimalcontrol import OptimalControl
-from c3.optimizers.c2 import C2
+from c3.optimizers.calibration import Calibration
 from c3.optimizers.c3 import C3
 from c3.optimizers.sensitivity import SET
 
@@ -36,7 +36,7 @@ def run_cfg(cfg, opt_config_filename, debug=False):
     optim_type = cfg.pop("optim_type")
     optim_lib = {
         "C1": OptimalControl,
-        "C2": C2,
+        "C2": Calibration,
         "C3": C3,
         "C3_confirm": C3,
         "confirm": C3,

c3/optimizers/c2.py renamed to c3/optimizers/calibration.py

@@ -10,7 +10,7 @@
 from c3.utils.utils import log_setup
 
 
-class C2(Optimizer):
+class Calibration(Optimizer):
     """
     Object that deals with the closed loop optimal control.
 

docs/Simulated_calibration.rst

@@ -165,7 +165,7 @@ We first import algorithms and the correct optimizer object.
     from c3.parametermap import ParameterMap as PMap
     from c3.libraries import algorithms, envelopes
     from c3.signal import gates, pulse
-    from c3.optimizers.c2 import C2
+    from c3.optimizers.calibration import C2
 
 Representation of the experiment within :math:`C^3`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/c3.optimizers.rst

@@ -12,7 +12,7 @@ C1 - Optimal control
 C2 - Calibration
 ----------------
 
-.. automodule:: c3.optimizers.c2
+.. automodule:: c3.optimizers.calibration
    :members:
    :undoc-members:
    :show-inheritance:

examples/Simulated_calibration.ipynb

@@ -197,7 +197,7 @@
     "from c3.parametermap import ParameterMap as PMap\n",
     "from c3.libraries import algorithms, envelopes\n",
     "from c3.signal import gates, pulse\n",
-    "from c3.optimizers.c2 import C2"
+    "from c3.optimizers.calibration import C2"
    ]
   },
   {

test/test_c2_calibration.py

@@ -21,7 +21,7 @@
 from c3.experiment import Experiment
 from c3.libraries import algorithms
 from c3.main import run_cfg
-from c3.optimizers.c2 import C2
+from c3.optimizers.calibration import Calibration
 from c3.parametermap import ParameterMap
 from c3.utils.qt_utils import single_length_RB
 
@@ -85,7 +85,7 @@ def test_calibration_cmaes() -> None:
     algo_options = cfg.pop("options")
     run_name = cfg.pop("run_name")
 
-    opt = C2(
+    opt = Calibration(
         dir_path=LOGDIR,
         run_name=run_name,
         eval_func=mock_ORBIT,