From 23cc12a45861455231eb9c3331a25b14e6fac9ab Mon Sep 17 00:00:00 2001
From: "Jens H. Nielsen" <Jens.Nielsen@microsoft.com>
Date: Tue, 30 Aug 2022 14:53:29 +0200
Subject: [PATCH 1/4] Add public api for alazar

---
 docs/drivers_api/AlazarTech.rst                   |  0
 qcodes/instrument_drivers/AlazarTech/ATS9360.py   |  6 +++++-
 qcodes/instrument_drivers/AlazarTech/ATS9373.py   |  6 +++++-
 qcodes/instrument_drivers/AlazarTech/ATS9440.py   |  6 +++++-
 qcodes/instrument_drivers/AlazarTech/ATS9870.py   |  6 +++++-
 .../AlazarTech/ATS_acquisition_controllers.py     |  6 +++++-
 qcodes/instrument_drivers/AlazarTech/__init__.py  | 15 +++++++++++++++
 7 files changed, 40 insertions(+), 5 deletions(-)
 create mode 100644 docs/drivers_api/AlazarTech.rst

diff --git a/docs/drivers_api/AlazarTech.rst b/docs/drivers_api/AlazarTech.rst
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/qcodes/instrument_drivers/AlazarTech/ATS9360.py b/qcodes/instrument_drivers/AlazarTech/ATS9360.py
index 3001485e102..09768027ddb 100644
--- a/qcodes/instrument_drivers/AlazarTech/ATS9360.py
+++ b/qcodes/instrument_drivers/AlazarTech/ATS9360.py
@@ -9,7 +9,7 @@
 from .utils import TraceParameter
 
 
-class AlazarTech_ATS9360(AlazarTech_ATS):
+class AlazarTechATS9360(AlazarTech_ATS):
     """
     This class is the driver for the ATS9360 board
     it inherits from the ATS base class
@@ -373,3 +373,7 @@ def _set_trigger_holdoff(self, value: bool) -> None:
             disable_mask = ~np.uint32(1 << 26)
             new_value = current_value & disable_mask
         self._write_register(58, int(new_value))
+
+
+class AlazarTech_ATS9360(AlazarTechATS9360):
+    pass
diff --git a/qcodes/instrument_drivers/AlazarTech/ATS9373.py b/qcodes/instrument_drivers/AlazarTech/ATS9373.py
index 38885c993dc..45e37a38489 100644
--- a/qcodes/instrument_drivers/AlazarTech/ATS9373.py
+++ b/qcodes/instrument_drivers/AlazarTech/ATS9373.py
@@ -8,7 +8,7 @@
 from qcodes.instrument_drivers.AlazarTech.utils import TraceParameter
 
 
-class AlazarTech_ATS9373(AlazarTech_ATS):
+class AlazarTechATS9373(AlazarTech_ATS):
     """
     This class is the driver for the ATS9373 board.
 
@@ -388,3 +388,7 @@ def _set_trigger_holdoff(self, value: bool) -> None:
             disable_mask = ~np.uint32(1 << 26)
             new_value = current_value & disable_mask
         self._write_register(58, int(new_value))
+
+
+class AlazarTech_ATS9373(AlazarTechATS9373):
+    pass
diff --git a/qcodes/instrument_drivers/AlazarTech/ATS9440.py b/qcodes/instrument_drivers/AlazarTech/ATS9440.py
index 4a74f9c5a52..f56f96f0322 100644
--- a/qcodes/instrument_drivers/AlazarTech/ATS9440.py
+++ b/qcodes/instrument_drivers/AlazarTech/ATS9440.py
@@ -6,7 +6,7 @@
 from .utils import TraceParameter
 
 
-class AlazarTech_ATS9440(AlazarTech_ATS):
+class AlazarTechATS9440(AlazarTech_ATS):
     """
     This class is the driver for the ATS9440 board
     it inherits from the ATS base class
@@ -300,3 +300,7 @@ def __init__(self, name: str,
                            set_cmd=None,
                            initial_value=1000,
                            vals=validators.Ints(min_value=0))
+
+
+class AlazarTech_ATS9440(AlazarTechATS9440):
+    pass
diff --git a/qcodes/instrument_drivers/AlazarTech/ATS9870.py b/qcodes/instrument_drivers/AlazarTech/ATS9870.py
index b973c5769f5..3693f4504b4 100644
--- a/qcodes/instrument_drivers/AlazarTech/ATS9870.py
+++ b/qcodes/instrument_drivers/AlazarTech/ATS9870.py
@@ -6,7 +6,7 @@
 from .utils import TraceParameter
 
 
-class AlazarTech_ATS9870(AlazarTech_ATS):
+class AlazarTechATS9870(AlazarTech_ATS):
     """
     This class is the driver for the ATS9870 board
     it inherits from the ATS base class
@@ -305,3 +305,7 @@ def __init__(self, name: str,
         if model != 'ATS9870':
             raise Exception(f"The Alazar board kind is not 'ATS9870',"
                             f" found '{str(model)}' instead.")
+
+
+class AlazarTech_ATS9870(AlazarTechATS9870):
+    pass
diff --git a/qcodes/instrument_drivers/AlazarTech/ATS_acquisition_controllers.py b/qcodes/instrument_drivers/AlazarTech/ATS_acquisition_controllers.py
index e47018ea862..5d782538809 100644
--- a/qcodes/instrument_drivers/AlazarTech/ATS_acquisition_controllers.py
+++ b/qcodes/instrument_drivers/AlazarTech/ATS_acquisition_controllers.py
@@ -7,7 +7,7 @@
 
 
 # DFT AcquisitionController
-class Demodulation_AcquisitionController(AcquisitionController[float]):
+class DemodulationAcquisitionController(AcquisitionController[float]):
     """
     This class represents an example acquisition controller. End users will
     probably want to use something more sophisticated. It will average all
@@ -158,3 +158,7 @@ def fit(self, buf: np.ndarray) -> Tuple[float, float]:
 
         # see manual page 52!!! (using unsigned data)
         return ampl, math.atan2(ImPart, RePart) * 360 / (2 * math.pi)
+
+
+class Demodulation_AcquisitionController(DemodulationAcquisitionController):
+    pass
diff --git a/qcodes/instrument_drivers/AlazarTech/__init__.py b/qcodes/instrument_drivers/AlazarTech/__init__.py
index e69de29bb2d..af1e7651e61 100644
--- a/qcodes/instrument_drivers/AlazarTech/__init__.py
+++ b/qcodes/instrument_drivers/AlazarTech/__init__.py
@@ -0,0 +1,15 @@
+from .ATS import AcquisitionController
+from .ATS9360 import AlazarTechATS9360
+from .ATS9373 import AlazarTechATS9373
+from .ATS9440 import AlazarTechATS9440
+from .ATS9870 import AlazarTechATS9870
+from .ATS_acquisition_controllers import DemodulationAcquisitionController
+
+__all__ = [
+    "AcquisitionController",
+    "AlazarTechATS9360",
+    "AlazarTechATS9373",
+    "AlazarTechATS9440",
+    "AlazarTechATS9870",
+    "DemodulationAcquisitionController",
+]

From 7c36aab55c3b8b37cd0c94f335c5c231c5265326 Mon Sep 17 00:00:00 2001
From: "Jens H. Nielsen" <Jens.Nielsen@microsoft.com>
Date: Tue, 30 Aug 2022 14:53:52 +0200
Subject: [PATCH 2/4] exclude alazar from old api docs

---
 docs/Makefile | 1 +
 docs/make.bat | 1 +
 2 files changed, 2 insertions(+)

diff --git a/docs/Makefile b/docs/Makefile
index 09fff28dcaa..088fd68984e 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -29,6 +29,7 @@ genapi:
 		../qcodes/instrument_drivers/american_magnetics\* \
 		../qcodes/instrument_drivers/agilent \
 		../qcodes/instrument_drivers/AimTTi \
+		../qcodes/instrument_drivers/AlazarTech \
 		../qcodes/instrument_drivers/basel \
 		../qcodes/instrument_drivers/HP \
 		../qcodes/instrument_drivers/ithaco \
diff --git a/docs/make.bat b/docs/make.bat
index 58ebe0e7952..4b9a9ecf7a2 100644
--- a/docs/make.bat
+++ b/docs/make.bat
@@ -39,6 +39,7 @@ REM for storing drivers, not the lower-case one).
 sphinx-apidoc  -o  _auto  -d 10 ..\qcodes ^
     ..\qcodes\instrument_drivers\agilent\* ^
     ..\qcodes\instrument_drivers\AimTTi ^
+    ..\qcodes\instrument_drivers\AlazarTech ^
     ..\qcodes\instrument_drivers\american_magnetics\* ^
     ..\qcodes\instrument_drivers\basel ^
     ..\qcodes\instrument_drivers\HP ^

From f4347c2af9c5140087dda0eace43065be118066d Mon Sep 17 00:00:00 2001
From: "Jens H. Nielsen" <Jens.Nielsen@microsoft.com>
Date: Tue, 30 Aug 2022 14:54:12 +0200
Subject: [PATCH 3/4] Add new api for alazar

---
 docs/drivers_api/AlazarTech.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/drivers_api/AlazarTech.rst b/docs/drivers_api/AlazarTech.rst
index e69de29bb2d..9787ca539c7 100644
--- a/docs/drivers_api/AlazarTech.rst
+++ b/docs/drivers_api/AlazarTech.rst
@@ -0,0 +1,7 @@
+.. _Alazar_api :
+
+Alazar Tech Drivers
+===================
+
+.. automodule:: qcodes.instrument_drivers.AlazarTech
+    :autosummary:

From db23d49d997fe3068e0afa6af9916758e5e867c7 Mon Sep 17 00:00:00 2001
From: "Jens H. Nielsen" <Jens.Nielsen@microsoft.com>
Date: Sat, 10 Sep 2022 06:24:40 +0200
Subject: [PATCH 4/4] add notes to old alias

---
 qcodes/instrument_drivers/AlazarTech/ATS9360.py               | 4 ++++
 qcodes/instrument_drivers/AlazarTech/ATS9373.py               | 4 ++++
 qcodes/instrument_drivers/AlazarTech/ATS9440.py               | 4 ++++
 qcodes/instrument_drivers/AlazarTech/ATS9870.py               | 4 ++++
 .../AlazarTech/ATS_acquisition_controllers.py                 | 4 ++++
 5 files changed, 20 insertions(+)

diff --git a/qcodes/instrument_drivers/AlazarTech/ATS9360.py b/qcodes/instrument_drivers/AlazarTech/ATS9360.py
index 09768027ddb..8078daf251d 100644
--- a/qcodes/instrument_drivers/AlazarTech/ATS9360.py
+++ b/qcodes/instrument_drivers/AlazarTech/ATS9360.py
@@ -376,4 +376,8 @@ def _set_trigger_holdoff(self, value: bool) -> None:
 
 
 class AlazarTech_ATS9360(AlazarTechATS9360):
+    """
+    Alias for backwards compatibility. Will eventually be deprecated and removed
+    """
+
     pass
diff --git a/qcodes/instrument_drivers/AlazarTech/ATS9373.py b/qcodes/instrument_drivers/AlazarTech/ATS9373.py
index 45e37a38489..7eab83750d2 100644
--- a/qcodes/instrument_drivers/AlazarTech/ATS9373.py
+++ b/qcodes/instrument_drivers/AlazarTech/ATS9373.py
@@ -391,4 +391,8 @@ def _set_trigger_holdoff(self, value: bool) -> None:
 
 
 class AlazarTech_ATS9373(AlazarTechATS9373):
+    """
+    Alias for backwards compatibility. Will eventually be deprecated and removed
+    """
+
     pass
diff --git a/qcodes/instrument_drivers/AlazarTech/ATS9440.py b/qcodes/instrument_drivers/AlazarTech/ATS9440.py
index f56f96f0322..a0498d4ae0f 100644
--- a/qcodes/instrument_drivers/AlazarTech/ATS9440.py
+++ b/qcodes/instrument_drivers/AlazarTech/ATS9440.py
@@ -303,4 +303,8 @@ def __init__(self, name: str,
 
 
 class AlazarTech_ATS9440(AlazarTechATS9440):
+    """
+    Alias for backwards compatibility. Will eventually be deprecated and removed
+    """
+
     pass
diff --git a/qcodes/instrument_drivers/AlazarTech/ATS9870.py b/qcodes/instrument_drivers/AlazarTech/ATS9870.py
index 3693f4504b4..a8414fa7d87 100644
--- a/qcodes/instrument_drivers/AlazarTech/ATS9870.py
+++ b/qcodes/instrument_drivers/AlazarTech/ATS9870.py
@@ -308,4 +308,8 @@ def __init__(self, name: str,
 
 
 class AlazarTech_ATS9870(AlazarTechATS9870):
+    """
+    Alias for backwards compatibility. Will eventually be deprecated and removed
+    """
+
     pass
diff --git a/qcodes/instrument_drivers/AlazarTech/ATS_acquisition_controllers.py b/qcodes/instrument_drivers/AlazarTech/ATS_acquisition_controllers.py
index 5d782538809..c7e99fe6256 100644
--- a/qcodes/instrument_drivers/AlazarTech/ATS_acquisition_controllers.py
+++ b/qcodes/instrument_drivers/AlazarTech/ATS_acquisition_controllers.py
@@ -161,4 +161,8 @@ def fit(self, buf: np.ndarray) -> Tuple[float, float]:
 
 
 class Demodulation_AcquisitionController(DemodulationAcquisitionController):
+    """
+    Alias for backwards compatibility. Will eventually be deprecated and removed
+    """
+
     pass