Merge pull request #4971 from jenshnielsen/remove_loop

Deprecate qcodes.data plot loops actions and measure
microsoft · Feb 9, 2023 · 83da2f1 · 83da2f1
2 parents 4e73552 + 305863f
commit 83da2f1
Show file tree

Hide file tree

Showing 78 changed files with 447 additions and 13,726 deletions.
diff --git a/README.rst b/README.rst
@@ -52,6 +52,19 @@ Go to the directory ``docs`` and
 This generate a webpage, index.html, in ``docs/_build/html`` with the
 rendered html.
 
+QCoDeS Loop
+===========
+
+The modules ``qcodes.data``, ``qcodes.plots``, ``qcodes.actions``,
+``qcodes.loops``, ``qcodes.measure``, ``qcodes.extensions.slack``
+and ``qcodes.utils.magic`` that were part of QCoDeS until version 0.37.0.
+have been moved into an independent package called qcodes_loop.
+Please see it's `repository <https://github.com/QCoDeS/Qcodes_loop`_ and
+`documentation <https://qcodes.github.io/Qcodes_loop/>`_ for more information.
+
+For the time being it is possible to automatically install the qcodes_loop
+package when installing qcodes by executing ``pip install qcodes[loop]``.
+
 Code of Conduct
 ===============
 

diff --git a/docs/api/actions.rst b/docs/api/actions.rst
diff --git a/docs/api/data/data_array.rst b/docs/api/data/data_array.rst
diff --git a/docs/api/data/data_set.rst b/docs/api/data/data_set.rst
diff --git a/docs/api/data/format.rst b/docs/api/data/format.rst
diff --git a/docs/api/data/gnuplot_format.rst b/docs/api/data/gnuplot_format.rst
diff --git a/docs/api/data/hdf5_format.rst b/docs/api/data/hdf5_format.rst
diff --git a/docs/api/data/hdf5_format_hickle.rst b/docs/api/data/hdf5_format_hickle.rst
diff --git a/docs/api/data/index.rst b/docs/api/data/index.rst
diff --git a/docs/api/data/io.rst b/docs/api/data/io.rst
diff --git a/docs/api/data/location.rst b/docs/api/data/location.rst
diff --git a/docs/api/extensions/slack.rst b/docs/api/extensions/slack.rst
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -4,9 +4,6 @@ QCoDes API documentation
 ========================
 
 This page documents the QCoDes API. This page contains documentation of all user facing modules.
-A few of our modules are considered legacy and documented separately below.
-This is split in roughly one page per QCoDeS submodule. A few of the submodules have been split for
-additional clarity.
 
 
 QCoDeS API
@@ -31,18 +28,3 @@ QCoDeS API
    station
    utils/index
    validators/index
-
-Legacy API
-----------
-
-.. toctree::
-   :maxdepth: 2
-   :includehidden:
-
-   loops
-   actions
-   measure
-   data/index
-   extensions/slack
-   plots/index
-   utils/magic
diff --git a/docs/api/loops.rst b/docs/api/loops.rst
diff --git a/docs/api/measure.rst b/docs/api/measure.rst
diff --git a/docs/api/plots/base.rst b/docs/api/plots/base.rst
diff --git a/docs/api/plots/colors.rst b/docs/api/plots/colors.rst
diff --git a/docs/api/plots/index.rst b/docs/api/plots/index.rst
diff --git a/docs/api/plots/pyqtgraph.rst b/docs/api/plots/pyqtgraph.rst
diff --git a/docs/api/plots/qcmatplotlib.rst b/docs/api/plots/qcmatplotlib.rst
diff --git a/docs/api/utils/magic.rst b/docs/api/utils/magic.rst
diff --git a/docs/changes/newsfragments/4971.breaking b/docs/changes/newsfragments/4971.breaking
@@ -0,0 +1,12 @@
+The modules ``qcodes_loop.data``, ``qcodes_loop.plots``, ``qcodes_loop.actions``, ``qcodes_loop.loops``,
+``qcodes_loop.measure``, ``qcodes_loop.extensions.slack`` and ``qcodes_loop.utils.magic``,
+``qcodes_loop.utils.qt_helpers`` have been split out into a separate package ``qcodes_loop``.
+The respective modules in QCoDeS do still exist as deprecated aliases to the new modules in ``qcodes_loop``
+but will be removed in a future release. To use the aliases QCoDeS must be installed with the ``loop`` extra e.g.
+you should install ``pip install qcodes[loop]``. If you make use of these modules we recommend updating imports
+to use ``qcodes_loop`` as soon as possible. See the `readme <https://github.com/qcodes/qcodes_loop>`_ of
+``qcodes_loop`` for more information.
+
+The functions ``qcodes.utils.helpers.tprint`` ``qcodes.utils.helpers.wait_secs`` and
+``qcodes.utils.helpers.foreground_qt_window`` have been removed.
+These helper functions are only used in ``qcodes_loop`` and were moved there.
diff --git a/docs/community/objects.rst b/docs/community/objects.rst
@@ -3,36 +3,6 @@ Object Hierarchy
 
 .. todo:: make sure it is updated and easy to read.
 
-Rough linkages:
----------------
-
-In **bold** the containing class creates this object. In *italics* the
-container just holds this object (or class) as a default for derivatives
-to use. Normal text shows the container includes and uses of this object.
-
--  Station
--  Instrument: IPInstrument, VisaInstrument, MockInstrument
-
-   -  **Parameter**
-   -  Validator: Anything, Strings, Numbers, Ints, Enum, MultiType
-   -  **SweepValues**: SweepFixedValues, AdaptiveSweep
-   -  Function
-   -  Validator
-
--  **Monitor**
--  *actions*
--  DataManager
--  **DataServer**
--  :ref:`loops_api`
--  actions: Parameter, Task, Wait, (Active)Loop
--  **ActiveLoop**
-
-   -  **DataSet**
-   -  **DataArray**
-   -  **Formatter**: GNUPlotFormat
-   -  **DiskIO** (may become subclass of IOManager?)
-   -  **FormatLocation** (a location\_provider)
-
 Station
 -------
 

diff --git a/docs/examples/index.rst b/docs/examples/index.rst
@@ -68,14 +68,3 @@ Logging
     :glob:
 
     logging/*
-
-
-Legacy examples
----------------
-
-.. include:: legacy/readme.txt
-
-.. toctree::
-    :glob:
-
-    legacy/*