Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate qcodes.data plot loops actions and measure #4971

Merged
merged 31 commits into from
Feb 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
4b59313
Deprecate actions, loops and measure
jenshnielsen Jan 31, 2023
a139e37
Deprecate data module
jenshnielsen Jan 31, 2023
d6d92c9
Deprecate plots module
jenshnielsen Jan 31, 2023
57584a7
improve deprecation messages
jenshnielsen Jan 31, 2023
9aa6720
remove legacy api from docs
jenshnielsen Jan 31, 2023
b6e7d18
remove legacy examples
jenshnielsen Jan 31, 2023
34b1ead
remove legacy tests
jenshnielsen Jan 31, 2023
d98c305
remove slack tests
jenshnielsen Jan 31, 2023
a3ccb8b
add one more level to deprecate
jenshnielsen Jan 31, 2023
5ca68ef
breaking: remove alias
jenshnielsen Jan 31, 2023
a7f42f2
remove loop related channel tests
jenshnielsen Jan 31, 2023
6bf9040
only depend on qcodes_loop in function that uses it
jenshnielsen Jan 31, 2023
0d40deb
fix legacy imports in legacy importer
jenshnielsen Jan 31, 2023
01ac106
Add future annotations to keithley 2600
jenshnielsen Jan 31, 2023
bf0a511
Fix legacy import in array/multiparameter and break dependency
jenshnielsen Jan 31, 2023
180b276
fix remaining imports
jenshnielsen Jan 31, 2023
43e4a2d
deprecate slack extension and fix type check
jenshnielsen Jan 31, 2023
e033684
deprecate magic
jenshnielsen Jan 31, 2023
9a498fd
deprecate magic
jenshnielsen Jan 31, 2023
c27bc0e
deprecate qt helpers
jenshnielsen Feb 1, 2023
3d19276
Breaking: remove alias for qt_helpers
jenshnielsen Feb 1, 2023
51e7cc2
improve deprecation messages
jenshnielsen Feb 2, 2023
3d7bef1
remove out of date section from docs
jenshnielsen Feb 2, 2023
254b9a5
add optional and testing deps on loop
jenshnielsen Feb 3, 2023
6289b62
fix broken dep when qcodes version is unknown
jenshnielsen Feb 3, 2023
1c1abdb
add docs dep on loop package
jenshnielsen Feb 3, 2023
ada0f4c
add try except around import in qcodes.data
jenshnielsen Feb 6, 2023
0cf14c4
Add changelog for 4971
jenshnielsen Feb 6, 2023
2f1fe7e
Add note to readme on loop package
jenshnielsen Feb 6, 2023
5b0a48b
Apply suggestions from code review
jenshnielsen Feb 7, 2023
305863f
Document loop extra target
jenshnielsen Feb 7, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
jenshnielsen marked this conversation as resolved.
Show resolved Hide resolved

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
===============

Expand Down
5 changes: 0 additions & 5 deletions docs/api/actions.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/data/data_array.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/data/data_set.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/data/format.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/data/gnuplot_format.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/data/hdf5_format.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/data/hdf5_format_hickle.rst

This file was deleted.

33 changes: 0 additions & 33 deletions docs/api/data/index.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/data/io.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/data/location.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/extensions/slack.rst

This file was deleted.

18 changes: 0 additions & 18 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
7 changes: 0 additions & 7 deletions docs/api/loops.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/measure.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/plots/base.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/plots/colors.rst

This file was deleted.

25 changes: 0 additions & 25 deletions docs/api/plots/index.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/plots/pyqtgraph.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/plots/qcmatplotlib.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/utils/magic.rst

This file was deleted.

12 changes: 12 additions & 0 deletions docs/changes/newsfragments/4971.breaking
Original file line number Diff line number Diff line change
@@ -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.
30 changes: 0 additions & 30 deletions docs/community/objects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------

Expand Down
11 changes: 0 additions & 11 deletions docs/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,3 @@ Logging
:glob:

logging/*


Legacy examples
---------------

.. include:: legacy/readme.txt

.. toctree::
:glob:

legacy/*
Loading