Debian Codegraph @

PyMeasure.egg-info/PKG-INFO

raw
1 Metadata-Version: 2.1
2 Name: PyMeasure
3 Version: 0.14.0
4 Summary: Scientific measurement library for instruments, experiments, and live-plotting
5 Home-page: https://github.com/pymeasure/pymeasure
6 Author: PyMeasure Developers
7 License: MIT
8 Keywords: measure,instrument,experiment control,automate,graph,plot
9 Classifier: Development Status :: 4 - Beta
10 Classifier: Intended Audience :: Science/Research
11 Classifier: License :: OSI Approved :: MIT License
12 Classifier: Operating System :: MacOS
13 Classifier: Operating System :: Microsoft :: Windows
14 Classifier: Operating System :: POSIX
15 Classifier: Operating System :: Unix
16 Classifier: Programming Language :: Python :: 3 :: Only
17 Classifier: Programming Language :: Python :: 3.8
18 Classifier: Programming Language :: Python :: 3.9
19 Classifier: Programming Language :: Python :: 3.10
20 Classifier: Programming Language :: Python :: 3.11
21 Classifier: Programming Language :: Python :: 3.12
22 Classifier: Topic :: Scientific/Engineering
23 Requires-Python: >=3.8
24 Description-Content-Type: text/x-rst
25 License-File: LICENSE.txt
26 Requires-Dist: numpy<3,>=1.6.1
27 Requires-Dist: pandas<3,>=0.14
28 Requires-Dist: pint
29 Requires-Dist: pyvisa>=1.9
30 Requires-Dist: pyserial>=2.7
31 Requires-Dist: pyqtgraph>=0.12
32 Requires-Dist: importlib-metadata; python_version < "3.8"
33 Provides-Extra: tcp
34 Requires-Dist: pyzmq>=16.0.2; extra == "tcp"
35 Requires-Dist: cloudpickle>=0.3.1; extra == "tcp"
36 Provides-Extra: python-vxi11
37 Requires-Dist: python-vxi11>=0.9; extra == "python-vxi11"
38 Provides-Extra: tests
39 Requires-Dist: pytest>=3.3.0; extra == "tests"
40 Requires-Dist: pytest-cov>=4.1.0; extra == "tests"
41 Requires-Dist: pytest-qt>=2.4.0; extra == "tests"
42 Requires-Dist: pyvisa-sim>=0.4.0; extra == "tests"
43
44 .. image:: https://raw.githubusercontent.com/pymeasure/pymeasure/master/docs/images/PyMeasure.png
45 :alt: PyMeasure Scientific package
46
47 PyMeasure scientific package
48 ############################
49
50 PyMeasure makes scientific measurements easy to set up and run.
51 The package contains a repository of instrument classes and a system for running experiment procedures, which provides graphical interfaces for graphing live data and managing queues of experiments.
52 Both parts of the package are independent, and when combined provide all the necessary requirements for advanced measurements with only limited coding.
53
54 PyMeasure is currently under active development, so please report any issues you experience to our `Issues page`_.
55
56 .. _Issues page: https://github.com/pymeasure/pymeasure/issues
57
58 PyMeasure runs on Python 3.8-3.12, and is tested with continuous-integration on Linux, macOS, and Windows.
59
60 .. image:: https://github.com/pymeasure/pymeasure/actions/workflows/pymeasure_CI.yml/badge.svg
61 :target: https://github.com/pymeasure/pymeasure/actions/workflows/pymeasure_CI.yml
62
63 .. image:: http://readthedocs.org/projects/pymeasure/badge/?version=latest
64 :target: http://pymeasure.readthedocs.io/en/latest/?badge=latest
65 :alt: Documentation Status
66
67 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.595633.svg
68 :target: https://doi.org/10.5281/zenodo.595633
69
70 .. image:: https://anaconda.org/conda-forge/pymeasure/badges/version.svg
71 :target: https://anaconda.org/conda-forge/pymeasure
72
73 .. image:: https://anaconda.org/conda-forge/pymeasure/badges/downloads.svg
74 :target: https://anaconda.org/conda-forge/pymeasure
75
76 .. image:: https://codecov.io/gh/pymeasure/pymeasure/graph/badge.svg
77 :target: https://codecov.io/gh/pymeasure/pymeasure
78
79
80 Quick start
81 ===========
82
83 Check out `the documentation`_ for the `quick start guide`_, that covers the installation of Python and PyMeasure.
84
85 There are a number of examples in the `examples`_ directory that can help you get up and running.
86
87 .. _the documentation: http://pymeasure.readthedocs.org/en/latest/
88 .. _quick start guide: http://pymeasure.readthedocs.io/en/latest/quick_start.html
89 .. _examples: https://github.com/pymeasure/pymeasure/tree/master/examples
90
91
92 Version 0.14.0 (2024-05-22)
93 ===========================
94 Main items of this new release:
95
96 - Add support for numpy 2.0
97 - Add support for python 3.12
98 - Improve academic quotability with an up to date Zenodo DOI and with citation information.
99 - Add default :code:`queue` method and a :code:`FileInputWidget`, allowing to more quickly get started with the PyMeasure user interface (:code:`ManagedWindow`).
100 - Add a :code:`SCPIMixin` base class for instruments instead of defining :code:`includeSCPI=True`
101 - Instrument manufacturer modules are no longer imported in the :code:`pymeasure/instruments/__init__.py` file.
102 Previously, when importing a single instrument into a procedure, all instruments would be imported into memory through the manufacturer modules in :code:`pymeasure/instruments/__init__.py`.
103 Removing manufacturer modules from that file lowers the memory footprint of pymeasure when importing an instrument.
104 Instrument classes will need to be imported from the manufacturer module or explicitly from the instrument driver file.
105 For example, :code:`from pymeasure.instruments import Extreme5000` will need to change to :code:`from pymeasure.instruments.extreme import Extreme5000` or :code:`from pymeasure.instruments.extreme.extreme5000 import Extreme5000`.
106 - 17 new instruments
107
108 Deprecated features
109 -------------------
110 - Remove :code:`TelnetAdapter`, as its library is deprecated (@BenediktBurger, #1045)
111 - Replaced :code:`directory_input` keyword-argument of :code:`ManagedWindowBase` by :code:`enable_file_input` (@CasperSchippers, #964)
112 - Make parameter :code:`includeSCPI` obligatory for all instruments, even those which use SCPI (@BenediktBurger, #1007)
113 - Setting `includeSCPI=True` is deprecated, inherit instead the :code:`SCPIMixin` class if the device supports SCPI commands.
114 - Replaced :code:`celcius` attribute of :code:`LakeShoreTemperatureChannel` by :code:`celsius` (@afuetterer, #1003)
115 - Replaced :code:`error` property of Keithley instruments by :code:`next_error`.
116 - Replaced :code:`measurement_time` property of Pendulum CNT-91 by :code:`gate_time`.
117 - Replaced :code:`sample_rate` keyword-argument of :code:`buffer_frequency_time_series` of Pendulum CNT-91 by :code:`gate_time`.
118 - Replaced MKS937B :code:`unit` to use :code:`instruments/mksinst/mks937b/Unit` instead of strings (@dkriegner, @BenediktBurger #1034)
119
120 Instruments mechanics
121 ---------------------
122 - Add a SCPI base class :code:`SCPIMixin` as replacement for :code:`includeSCPI=True` (@BenediktBurger, #905, #1007, #1019, #1047)
123 - Add :code:`next_error` property to SCPI instruments (@BenediktBurger, #1024)
124 - Make :code:`query_delay=None` the default for :code:`wait_for` (@BenediktBurger, #1077)
125 - Fix :code:`expected_protocol` using empty dictionary as default value (@BenediktBurger, #1087)
126 - Remove auto-importing all instruments in :code:`pymeasure/instruments/__init__.py`` (@mcdo0486, #919)
127 - Add :code:`find_serial_port` to find a serial port by providing USB information (@BenediktBurger, #982)
128
129 Instruments
130 -----------
131 - Add Agilent4294A (@driftregion, #998)
132 - Add Agilent 4284A by (@ConnorGCarr #1079)
133 - Add AimTTI PL series power supplies (@guuskuiper, #942)
134 - Add HP11713A Switch & Attenuator Driver (@neuschs, #970)
135 - Add HP437B power meter (@neuschs, #979)
136 - Add Inficon SQM160 SQM-160 multi-film rate/thickness monitor (@dkriegner, #991)
137 - Add Keithley 2182 (@ConnorGCarr, #1043)
138 - Add KeithleyDMM6500 (@fwutw, #963)
139 - Add Kepco BOP 36-12 Bipolar Power Supply (@JAW90, #1086)
140 - Add KeysightE3631A (@OptimisticBeliever, #990)
141 - Add Kuhne Electronic KU SG 2.45 250A microwave generator (@jurajjasik, @BenediktBurger, @1108)
142 - Add MKS 974B vacuum pressure transducer (@dkriegner, #1034)
143 - Add Proterial rod4 (@ConnorGCarr, #1044)
144 - Add Racal-Dana 1992 universal counter (@tomverbeure, #798, #1012)
145 - Add redpitaya board (@seb5g, #1010, #1035)
146 - Add Teledyne HDO6xxx (@RobertoRoos, #868)
147 - Add Yokogawa AQ6370D Optical Spectral Analyzer (@jnnskls, #1059)
148 - Fix property docstrings of several instruments (@BenediktBurger, #1018)
149 - Fix checksums of hcp TC038D tests (@BenediktBurger, #987)
150 - Fix Hp8116a (@BenediktBurger, #1088)
151 - Fix Hp856x to append amplitude units (@neuschs, #977)
152 - Fix Keysight E36312A confirmed SCPI functionality (@Konradrundfunk, #1107)
153 - Fix Stanford Research SR830 output conversion (@dkriegner, #1069)
154 - Fix SR830 missing get_buffer method (@seb5g, #999)
155 - Fix set command of SR860 aux output (@wehlgrundspitze, #1048)
156 - Fix Temptronic test to use ns perf counter (@BenediktBurger, #1109, #1110)
157 - Fix Toptica Ibeamsmart referencing removed adapter function (@BenediktBurger, #1065)
158 - Fix typos in docstrings for Keithley instruments (@V0XNIHILI, #1071)
159 - Link Keysight, Agilent, and HP documentation pages. (@BenediktBurger, #1021)
160 - Update Agilent33500 Series from :code:`.ch[]` to :code:`.channels[]` (@AlecVercruysse, #945)
161 - Update AWG401x driver to use 'channels' (@mcdo0486, #944)
162 - Update HP33120A with new burst modulation parameters (@mzen228, #1056)
163 - Update HP34401A with new remote control command. (@Rybok, #992)
164 - Update Keithleys' next_error (@msmttchr, #1030)
165 - Update pendulum CNT-91 (@bleykauf, #988)
166
167 GUI
168 ---
169 - Add a :code:`FileInputWidget` to choose if and where the experiment data is stored. (@CasperSchippers, #964)
170 - Add a default :code:`Queue` method for :code:`ManagedWindowBase` is implemented. (@CasperSchippers, #964)
171 - Fix :code:`ScientificInput` to be locale compatible (@pyZerrenner, #1074)
172 - Fix exception if loading result file with an empty parameter (@poje42, #1016)
173
174 Miscellaneous
175 -------------
176 - Add support for python 3.12 (@BenediktBurger, #1051)
177 - Add support for numpy 2.0 (@CasperSchippers, #1026)
178 - Add codecov to CI and to readme (@BenediktBurger, #1037, #1052, #1099)
179 - Add citation file for PyMeasure repository (@mcdo0486, #1092)
180 - Add release CI (@BenediktBurger, #1039)
181 - Update readme with permanent Zenodo DOI (@BenediktBurger, #1095)
182 - Bump CI dependencies to: pyvisa 1.13.0, checkout@v4 (@mcdo0486, #1097)
183 - Fix/pandas futurewarning (@CasperSchippers, #1062)
184 - Change copyright year. (@BenediktBurger, #1032)
185 - Fix typos (@afuetterer, #1003)
186
187 New Contributors
188 ----------------
189 @guuskuiper, @OptimisticBeliever, @fwutw, @afuetterer, @poje42, @Rybok, @AlecVercruysse, @ConnorGCarr, @mzen228, @jnnskls, @V0XNIHILI, @pyZerrenner, @JAW90, @driftregion, @jurajjasik, @Konradrundfunk
190
191 **Full Changelog**: https://github.com/pymeasure/pymeasure/compare/v0.13.1...v0.14.0
192
193
194 Version 0.13.1 (2023-10-05)
195 ===========================
196 New release to fix ineffective python version restriction in the project metadata (only affected Python<=3.7 environments installing via pip).
197
198 Version 0.13.0 (2023-09-23)
199 ===========================
200 Main items of this new release:
201
202 - Dropped support for Python 3.7, added support for Python 3.11.
203 - Adds a test generator, which observes the communication with an actual device and writes protocol tests accordingly.
204 - 2 new instrument drivers have been added.
205
206 Deprecated features
207 -------------------
208 - Attocube ANC300: The :code:`stepu` and :code:`stepd` properties are deprecated, use the new :code:`move_raw` method instead. (@dkriegner, #938)
209
210 Instruments
211 -----------
212 - Adds a test generator (@bmoneke, #882)
213 - Adds Thyracont Smartline v2 vacuum sensor transmitter (@bmoneke, #940)
214 - Adds Thyracont Smartline v1 vacuum gauge (@dkriegner, #937)
215 - AddsTeledyne base classes with most of `LeCroyT3DSO1204` functionality (@RobertoRoos, #951)
216 - Fixes instrument documentation (@mcdo0486, #941, #903, @omahs, #960)
217 - Fixes Toptica Ibeamsmart's __init__ (@waveman68, #959)
218 - Fixes VISAAdapter flush_read_buffer() (@ileu, #968)
219 - Updates Keithley2306 and AFG3152C to Channels (@bilderbuchi, #953)
220
221 GUI
222 ---
223 - Adds console mode (@msmttchr, #500)
224 - Fixes Dock widget (@msmttchr, #961)
225
226 Miscellaneous
227 -------------
228 - Change CI from conda to mamba (@bmoneke, #947)
229 - Add support for python 3.11 (@CasperSchippers, #896)
230
231 New Contributors
232 ----------------
233 @waveman68, @omahs, @ileu
234
235 **Full Changelog**: https://github.com/pymeasure/pymeasure/compare/v0.12.0...v0.13.0
236
237
238 Version 0.12.0 (2023-07-05)
239 ===========================
240 Main items of this new release:
241
242 - A :code:`Channel` base class has been added for easier implementation of instruments with channels.
243 - 19 new instrument drivers have been added.
244 - Added tests for some commonalities across all instruments.
245 - We continue to clean up our API in preparation for a future version 1.0. Deprecations and subsequent removals are listed below.
246
247 Deprecated features
248 -------------------
249 - HP 34401A: :code:`voltage_ac`, :code:`current_dc`, :code:`current_ac`, :code:`resistance`, :code:`resistance_4w` properties, use :code:`function_` and :code:`reading` properties instead.
250 - Toptica IBeamSmart: :code:`channel1_enabled`, use :code:`ch_1.enabled` property instead (equivalent for channel2). Also :code:`laser_enabled` is deprecated in favor of :code:`emission` (@bmoneke, #819).
251 - TelnetAdapter: use :code:`VISAAdapter` instead. VISA supports TCPIP connections. Use the resource_name :code:`TCPIP[board]::<hostname>::<port>::SOCKET` to connect to a server (@Max-Herbold, #835).
252 - Attocube ANC300: :code:`host` argument, pass a resource string or adapter as :code:`Adapter` passed to :code:`Instrument`. Now communicates through the :code:`VISAAdapter` rather than deprecated :code:`TelnetAdapter`. The initializer now accepts :code:`name` as its second keyword argument so all previous initialization positional arguments (`axisnames`, `passwd`, `query_delay`) should be switched to keyword arguments.
253 - The property creators :code:`control`, :code:`measurement`, and :code:`setting` do not accept arbitrary keyword arguments anymore. Use the :code:`v_kwargs` parameter for arguments you want to pass on to :code:`values` method, instead.
254 - The property creators :code:`control`, :code:`measurement`, and :code:`setting` do not accept `command_process` anymore. Use a dynamic property or a `Channel` instead, as appropriate (@bmoneke, #878).
255 - See also the next section.
256
257 New adapter and instrument mechanics
258 ------------------------------------
259 - All instrument constructors are required to accept a :code:`name` argument.
260 - Changed: :code:`read_bytes` of all Adapters by default does not stop reading on a termination character, unless the new argument :code:`break_on_termchar` is set to `True`.
261 - Channel class added. :code:`Instrument.channels` and :code:`Instrument.ch_X` (:code:`X` is any channel name) are reserved attributes for channel mechanics.
262 - The parameters :code:`check_get_errors` and :code:`check_set_errors` enable calling methods of the same name. This enables more systematically dealing with instruments that acknowledge every "set" command.
263
264 - Adds Channel feature to instruments (@bmoneke, mcdo0486, #718, #761, #852, #931)
265 - Adds :code:`maxsplit` parameter to :code:`values` method (@bmoneke, #793)
266 - Adds (deprecated) global preprocess reply for backward compatibility (@bmoneke, #876)
267 - Adds fallback version for discarding the read buffer to VISAAdapter (@dkriegner, #836)
268 - Adds :code:`flush_read_buffer` to SerialAdapter (@RobertoRoos, #865)
269 - Adds :code:`gpib_read_timeout` to PrologixAdapter (@neuschs, #927)
270 - Adds command line option to pass resource address for instrument tests (@bleykauf, #789)
271 - Adds "find all instruments" and channels for testing (@bmoneke, #909, @mcdo0486, #911, #912)
272 - Adds test that an instrument hands kwargs to the adapter (@bmoneke, #814)
273 - Adds property docstring check (@bmoneke, #895)
274 - Improves property factories' docstrings (@bmoneke, #843)
275 - Improves property factories: do not allow undefined kwargs (@bmoneke, #856)
276 - Improves property factories: check_set/get_errors argument to call methods of the same name (@bmoneke, #883)
277 - Improves :code:`read_bytes` of Adapter (@bmoneke, #839)
278 - Improves the ProtocolAdapter with a mock connection (@bmoneke, #782), and enable it to have empty messages in the protocol (@bmoneke, #818)
279 - Improves Prologix adapter documentation (@bmoneke, #813) and configurable settings (@bmoneke, #845)
280 - Improves behavior of :code:`read_bytes(-1)` for :code:`SerialAdapter` (@RobertoRoos, #866)
281 - Improves all instruments with name kwarg (@bmoneke, #877)
282 - Improves VisaAdapter: close manager only when using pyvisa-sim (@dkriegner, #900)
283 - Harmonises instrument name definition pattern, consistently name the instrument connection argument "adapter" (@bmoneke, #659)
284 - Fixes ProtocolAdapter has list in signature (@bmoneke, #901)
285 - Fixes VISAAdapter's :code:`read_bytes` (@bmoneke, #867)
286 - Fixes query_delay usage in VISAAdapter (@bmoneke, #765)
287 - Fixes VisaAdapter: close resource manager only when using pyvisa-sim (@dkriegner, #900)
288
289 Instruments
290 -----------
291 - New Advantest R624X DC Voltage/Current Sources/Monitors (@wichers, #802)
292 - New AJA International DC sputtering power supply (@dkriegner, #778)
293 - New Anritus MS2090A (@aruznieto, #787)
294 - New Anritsu MS4644B (@CasperSchippers, #827)
295 - New DSP 7225 and new DSPBase instrument (@mcdo0486, #902)
296 - New HP 8560A / 8561B Spectrum Analyzer (@neuschs, #888)
297 - New IPG Photonics YAR Amplifier series (@bmoneke, #851)
298 - New Keysight E36312A power supply (@scandey, #785)
299 - New Keithley 2200 power supply (@ashokbruno, #806)
300 - New Lake Shore 211 Temperature Monitor (@mcdo0486, #889)
301 - New Lake Shore 224 and improves Lakeshore instruments (@samcondon4, #870)
302 - New MKS Instruments 937B vacuum gauge controller (@dkriegner, @bilderbuchi, #637, #772, #936)
303 - New Novanta FPU60 laser power supply unit (@bmoneke, #885)
304 - New TDK Lambda Genesys 80-65 DC and 40-38 DC power supplies (@mcdo0486, 906)
305 - New Teledyne T3AFG waveform generator instrument (@scandey, #791)
306 - New Teledyne (LeCroy) T3DSO1204 Oscilloscope (@LastStartDust, #697, @bilderbuchi, #770)
307 - New T&C Power Conversion RF power supply (@dkriegner, #800)
308 - New Velleman K8090 relay device (@RobertoRoos, #859)
309 - Improves Agilent 33500 with the new channel feature (@JCarl-OS, #763, #773)
310 - Improves HP 3478A with calibration data related functions (@tomverbeure, #777)
311 - Improves HP 34401A (@CodingMarco, #810)
312 - Improves the Oxford instruments with the new channel feature (@bmoneke, #844)
313 - Improves Siglent SPDxxxxX with the new channel feature (@AidenDawn 758)
314 - Improves Teledyne T3DSO1204 device tests (@LastStarDust, #841)
315 - Fixes Ametek DSP 7270 lockin amplifier issues (@seb5g, #897)
316 - Fixes DSP 7265 erroneously using preprocess_reply (@mcdo0486, #873)
317 - Fixes print statement in DSPBase.sensitivity (@mcdo0486, #915)
318 - Fixes Fluke bath commands (@bmoneke, #874)
319 - Fixes a frequency limitation in HP 8657B (@LongnoseRob, #769)
320 - Fixes Keithley 2600 channel calling parent's shutdown (@mcdo0486, #795)
321
322 Automation
323 ----------
324 - Adds tolerance for opening result files with missing parameters (@msmttchr, #780)
325 - Validate DATA_COLUMNS entries earlier, avoid exceptions in a running procedure (@mcdo0486, #796, #934)
326
327 GUI
328 ---
329 - Adds docking windows (@mcdo0486, #722, #762)
330 - Adds save plot settings in addition to dock layout (@mcdo0486, #850)
331 - Adds log widget colouring and format option (@CasperSchippers, #890)
332 - Adds table widget (@msmttchr, #771)
333 - New sequencer architecture: decouples it from the graphical tree, adapts it for further expansions (@msmttchr, #518)
334 - Moves coordinates label to the pyqtgraph PlotItem (@CasperSchippers, #822)
335 - Fixes crashing ImageWidget at new measurement (@CasperSchippers, #790)
336 - Fixes checkboxes not working for groups in inputs-widget (@CasperSchippers, #794)
337
338 Miscellaneous
339 -------------
340 - Adds a collection of solutions for instrument implementation challenges (@bmoneke, #853, #861)
341 - Updates Tutorials/Making_a_measurement/ example_codes (@sansanda, #749)
342
343 New Contributors
344 ----------------
345 @JCarl-OS, @aruznieto, @scandey, @tomverbeure, @wichers, @Max-Herbold, @RobertoRoos
346
347 **Full Changelog**: https://github.com/pymeasure/pymeasure/compare/v0.11.1...v0.12.0
348
349 Version 0.11.1 (2022-12-31)
350 ===========================
351 Adapter and instrument mechanics
352 --------------------------------
353 - Fix broken `PrologixAdapter.gpib`. Due to a bug in `VISAAdapter`, you could not get a second adapter with that connection (#765).
354
355 **Full Changelog**: https://github.com/pymeasure/pymeasure/compare/v0.11.0...v0.11.1
356
357 Dependency updates
358 ------------------
359 - Required version of `PyQtGraph <https://www.pyqtgraph.org/>`__ is increased from :code:`pyqtgraph >= 0.9.10` to :code:`pyqtgraph >= 0.12` to support new PyMeasure display widgets.
360
361 GUI
362 ---
363 - Added `ManagedDockWindow <https://pymeasure.readthedocs.io/en/latest/tutorial/graphical.html#using-the-manageddockwindow>`__ to allow multiple dockable plots (@mcdo0486, @CasperSchippers, #722)
364 - Move coordinates label to the pyqtgraph PlotItem (@CasperSchippers, #822)
365 - New sequencer architecture (@msmttchr, @CasperSchippers, @mcdo0486, #518)
366 - Added "Save Dock Layout" functionality to DockWidget context menu. (@mcdo0486, #762)
367
368 Version 0.11.0 (2022-11-19)
369 ===========================
370 Main items of this new release:
371
372 - 11 new instrument drivers have been added
373 - A method for testing instrument communication **without** hardware present has been added, see `the documentation <https://pymeasure.readthedocs.io/en/latest/dev/adding_instruments.html#protocol-tests>`__.
374 - The separation between :code:`Instrument` and :code:`Adapter` has been improved to make future modifications easier. Adapters now focus on the hardware communication, and the communication *protocol* should be defined in the Instruments. Details in a section below.
375 - The GUI is now compatible with Qt6.
376 - We have started to clean up our API in preparation for a future version 1.0. There will be deprecations and subsequent removals, which will be prominently listed in the changelog.
377
378 Deprecated features
379 -------------------
380 In preparation for a stable 1.0 release and a more consistent API, we have now started formally deprecating some features.
381 You should get warnings if those features are used.
382
383 - Adapter methods :code:`ask`, :code:`values`, :code:`binary_values`, use :code:`Instrument` methods of the same name instead.
384 - Adapter parameter :code:`preprocess_reply`, override :code:`Instrument.read` instead.
385 - :code:`Adapter.query_delay` in favor of :code:`Instrument.wait_for()`.
386 - Keithley 2260B: :code:`enabled` property, use :code:`output_enabled` instead.
387
388 New adapter and instrument mechanics
389 ------------------------------------
390 - Nothing should have changed for users, this section is mainly interesting for instrument implementors.
391 - Documentation in 'Advanced communication protocols' in 'Adding instruments'.
392 - Adapter logs written and read messages.
393 - Particular adapters (`VISAAdapter` etc.) implement the actual communication.
394 - :code:`Instrument.control` getter calls :code:`Instrument.values`.
395 - :code:`Instrument.values` calls :code:`Instrument.ask`, which calls :code:`Instrument.write`, :code:`wait_for`, and :code:`read`.
396 - All protocol quirks of an instrument should be implemented overriding :code:`Instrument.write` and :code:`read`.
397 - :code:`Instrument.wait_until_read` implements waiting between writing and reading.
398 - reading/writing binary values is in the :code:`Adapter` class itself.
399 - :code:`PrologixAdapter` is now based on :code:`VISAAdapter`.
400 - :code:`SerialAdapter` improved to be more similar to :code:`VISAAdapter`: :code:`read`/:code:`write` use strings, :code:`read/write_bytes` bytes. - Support for termination characters added.
401
402 Instruments
403 -----------
404 - New Active Technologies AWG-401x (@garzetti, #649)
405 - New Eurotest hpp_120_256_ieee (@sansanda, #701)
406 - New HC Photonics crystal ovens TC038, TC038D (@bmoneke, #621, #706)
407 - New HP 6632A/6633A/6634A power supplies (@LongnoseRob, #651)
408 - New HP 8657B RF signal generator (@LongnoseRob, #732)
409 - New Rohde&Schwarz HMP4040 power supply. (@bleykauf, #582)
410 - New Siglent SPDxxxxX series Power Supplies (@AidenDawn, #719)
411 - New Temptronic Thermostream devices (@mroeleke, #368)
412 - New TEXIO PSW-360L30 Power Supply (@LastStarDust, #698)
413 - New Thermostream ECO-560 (@AidenDawn, #679)
414 - New Thermotron 3800 Oven (@jcarbelbide, #606)
415 - Harmonize instruments' adapter argument (@bmoneke, #674)
416 - Harmonize usage of :code:`shutdown` method (@LongnoseRob, #739)
417 - Rework Adapter structure (@bmoneke, #660)
418 - Add Protocol tests without hardware present (@bilderbuchi, #634, @bmoneke, #628, #635)
419 - Add Instruments and adapter protocol tests for adapter rework (@bmoneke, #665)
420 - Add SR830 sync filter and reference source trigger (@AsafYagoda, #630)
421 - Add Keithley6221 phase marker phase and line (@AsafYagoda, #629)
422 - Add missing docstrings to Keithley 2306 battery simulator (@AidenDawn, #720)
423 - Fix hcp instruments documentation (@bmoneke, #671)
424 - Fix HPLegacyInstrument initializer API (@bilderbuchi, #684)
425 - Fix Fwbell 5080 implementation (@mcdo0486, #714)
426 - Fix broken documentation example. (@bmoneke, #738)
427 - Fix typo in Keithley 2600 driver (@mcdo0486, #615)
428 - Remove dynamic use of docstring from ATS545 and make more generic (@AidenDawn, #685)
429
430 Automation
431 ----------
432 - Add storing unitful experiment results (@bmoneke, #642)
433 - Add storing conditions in file (@CasperSchippers, #503)
434
435 GUI
436 ---
437 - Add compatibility with Qt 6 (@CasperSchippers, #688)
438 - Add spinbox functionality for IntegerParameter and FloatParameter (@jarvas24, #656)
439 - Add "delete data file" button to the browser_item_menu (@jarvas24, #654)
440 - Split windows.py into a folder with separate modules (@mcdo0486, #593)
441 - Remove dependency on matplotlib (@msmttchr, #622)
442 - Remove deprecated access to QtWidgets through QtGui (@maederan201, #695)
443
444 Miscellaneous
445 -------------
446 - Update and extend documentation (@bilderbuchi, #712, @bmoneke, #655)
447 - Add PEP517 compatibility & dynamically obtaining a version number (@bilderbuchi, #613)
448 - Add an example and documentation regarding using a foreign instrument (@bmoneke, #647)
449 - Add black configuration (@bleykauf, #683)
450 - Remove VISAAdapter.has_supported_version() as it is not needed anymore.
451
452 New Contributors
453 ----------------
454 @jcarbelbide, @mroeleke, @bmoneke, @garzetti, @AsafYagoda, @AidenDawn, @LastStarDust, @sansanda
455
456 **Full Changelog**: https://github.com/pymeasure/pymeasure/compare/v0.10.0...v0.11.0
457
458 Version 0.10.0 (2022-04-09)
459 ===========================
460 Main items of this new release:
461
462 - 23 new instrument drivers have been added
463 - New dynamic Instrument properties can change their parameters at runtime
464 - Communication settings can now be flexibly defined per protocol
465 - Python 3.10 support was added and Python 3.6 support was removed.
466 - Many additions, improvements and have been merged
467
468 Instruments
469 -----------
470 - New Agilent B1500 Data Formats and Documentation (@moritzj29)
471 - New Anaheim Automation stepper motor controllers (@samcondon4)
472 - New Andeen Hagerling capacitance bridges (@dkriegner)
473 - New Anritsu MS9740A Optical Spectrum Analyzer (@md12g12)
474 - New BK Precision 9130B Instrument (@dennisfeng2)
475 - New Edwards nXDS (10i) Vacuum Pump (@hududed)
476 - New Fluke 7341 temperature bath instrument (@msmttchr)
477 - New Heidenhain ND287 Position Display Unit Driver (@samcondon4)
478 - New HP 3478A (@LongnoseRob)
479 - New HP 8116A 50 MHz Pulse/Function Generator (@CodingMarco)
480 - New Keithley 2260B DC Power Supply (@bklebel)
481 - New Keithley 2306 Dual Channel Battery/Charger Simulator (@mfikes)
482 - New Keithley 2600 SourceMeter series (@Daivesd)
483 - New Keysight N7776C Swept Laser Source (@maederan201)
484 - New Lakeshore 421 (@CasperSchippers)
485 - New Oxford IPS120-10 (@CasperSchippers)
486 - New Pendulum CNT-91 frequency counter (@bleykauf)
487 - New Rohde&Schwarz - SFM TV test transmitter (@LongnoseRob)
488 - New Rohde&Schwarz FSL spectrum analyzer (@bleykauf)
489 - New SR570 current amplifier driver (@pyMatJ)
490 - New Stanford Research Systems SR510 instrument driver (@samcondon4)
491 - New Toptica Smart Laser diode (@dkriegner)
492 - New Yokogawa GS200 Instrument (@dennisfeng2)
493 - Add output low grounded property to Keithley 6221 (@CasperSchippers)
494 - Add shutdown function for Keithley 2260B (@bklebel)
495 - Add phase control for Agilent 33500 (@corna)
496 - Add assigning "ONCE" to auto_zero to Keithley 2400 (@mfikes)
497 - Add line frequency controls to Keithley 2400 (@mfikes)
498 - Add LIA and ERR status byte read properties to the SRS Sr830 driver (@samcondon4)
499 - Add all commands to Oxford Intelligent Temperature Controller 503 (@CasperSchippers)
500 - Fix DSP 7265 lockin amplifier (@CasperSchippers)
501 - Fix bug in Keithley 6517B Electrometer (@CasperSchippers)
502 - Fix Keithley2000 deprecated call to visa.config (@bklebel)
503 - Fix bug in the Keithley 2700 (@CasperSchippers)
504 - Fix setting of sensor flags for Thorlabs PM100D (@bleykauf)
505 - Fix SCPI used for Keithley 2400 voltage NPLC (@mfikes)
506 - Fix missing return statements in Tektronix AFG3152C (@bleykauf)
507 - Fix DPSeriesMotorController bug (@samcondon4)
508 - Fix Keithley2600 error when retrieving error code (@bicarlsen)
509 - Fix Attocube ANC300 with new SCPI Instrument properties (@dkriegner)
510 - Fix bug in wait_for_trigger of Agilent33220A (neal-kepler)
511
512 GUI
513 ---
514 - Add time-estimator widget (@CasperSchippers)
515 - Add management of progress bar (@msmttchr)
516 - Remove broken errorbar feature (@CasperSchippers)
517 - Change of pen width for pyqtgraph (@maederan201)
518 - Make linewidth changeable (@CasperSchippers)
519 - Generalise warning in plotter section (@CasperSchippers)
520 - Implement visibility groups in InputsWidgets (@CasperSchippers)
521 - Modify navigation of ManagedWindow directory widget (@jarvas24)
522 - Improve Placeholder logic (@CasperSchippers)
523 - Breakout widgets into separate modules (@mcdo0486)
524 - Fix setSizePolicy bug with PySide2 (@msmttchr)
525 - Fix managed window (@msmttchr)
526 - Fix ListParameter for numbers (@moritzj29)
527 - Fix incorrect columns on showing data (@CasperSchippers)
528 - Fix procedure property issue (@msmttchr)
529 - Fix pyside2 (@msmttchr)
530
531 Miscellaneous
532 -------------
533 - Improve SCPI property support (@msmttchr)
534 - Remove broken safeKeyword management (@msmttchr)
535 - Add dynamic property support (@msmttchr)
536 - Add flexible API for defining connection configuration (@bilderbuchi)
537 - Add write_binary_values() to SerialAdapter (@msmttchr)
538 - Change an outdated pyvisa ask() to query() (@LongnoseRob)
539 - Fix ZMQ bug (@bilderbuchi)
540
541 - Documentation for passing tuples to control property (@bklebel)
542 - Documentation bugfix (@CasperSchippers)
543 - Fixed broken links in documentation. (@samcondon4)
544 - Updated widget documentation (@mcdo0486)
545 - Fix typo SCIP->SCPI (@mfikes)
546
547 - Remove Python 3.6, add Python 3.10 testing (@bilderbuchi)
548 - Modernise the code base to use Python 3.7 features (@bilderbuchi)
549 - Added image data generation to Mock Instrument class (@samcondon4)
550 - Add autodoc warnings to the problem matcher (@bilderbuchi)
551 - Update CI & annotations (@bilderbuchi)
552 - Test workers (@mcdo0486)
553 - Change copyright date to 2022 (@LongnoseRob)
554 - Removed unused code (@msmttchr)
555
556 New Contributors
557 ----------------
558 @LongnoseRob, @neal, @hududed, @corna, @Daivesd, @samcondon4, @maederan201, @bleykauf, @mfikes, @bicarlsen, @md12g12, @CodingMarco, @jarvas24, @mcdo0486!
559
560 **Full Changelog**: https://github.com/pymeasure/pymeasure/compare/v0.9...v0.10.0
561
562 Version 0.9 -- released 2/7/21
563 ==============================
564 - PyMeasure is now officially at github.com/pymeasure/pymeasure
565 - Python 3.9 is now supported, Python 3.5 removed due to EOL
566 - Move to GitHub Actions from TravisCI and Appveyor for CI (@bilderbuchi)
567 - New additions to Oxford Instruments ITC 503 (@CasperSchippers)
568 - New Agilent 34450A and Keysight DSOX1102G instruments (@theMashUp, @jlarochelle)
569 - Improvements to NI VirtualBench (@moritzj29)
570 - New Agilent B1500 instrument (@moritzj29)
571 - New Keithley 6517B instrument (@wehlgrundspitze)
572 - Major improvements to PyVISA compatbility (@bilderbuchi, @msmttchr, @CasperSchippers, @cjermain)
573 - New Anapico APSIN12G instrument (@StePhanino)
574 - Improvements to Thorelabs Pro 8000 and SR830 (@Mike-HubGit)
575 - New SR860 instrument (@StevenSiegl, @bklebel)
576 - Fix to escape sequences (@tirkarthi)
577 - New directory input for ManagedWindow (@paulgoulain)
578 - New TelnetAdapter and Attocube ANC300 Piezo controller (@dkriegner)
579 - New Agilent 34450A (@theMashUp)
580 - New Razorbill RP100 strain cell controller (@pheowl)
581 - Fixes to precision and default value of ScientificInput and FloatParameter (@moritzj29)
582 - Fixes for Keithly 2400 and 2450 controls (@pyMatJ)
583 - Improvments to Inputs and open_file_externally (@msmttchr)
584 - Fixes to Agilent 8722ES (@alexmcnabb)
585 - Fixes to QThread cleanup (@neal-kepler, @msmttchr)
586 - Fixes to Keyboard interrupt, and parameters (@CasperSchippers)
587
588 Version 0.8 -- released 3/29/19
589 ===============================
590 - Python 3.8 is now supported
591 - New Measurement Sequencer allows for running over a large parameter space (@CasperSchippers)
592 - New image plotting feature for live image measurements (@jmittelstaedt)
593 - Improvements to VISA adapter (@moritzj29)
594 - Added Tektronix AFG 3000, Keithley 2750 (@StePhanino, @dennisfeng2)
595 - Documentation improvements (@mivade)
596 - Fix to ScientificInput for float strings (@moritzj29)
597 - New validator: strict_discrete_range (@moritzj29)
598 - Improvements to Recorder thread joining
599 - Migrating the ReadtheDocs configuration to version 2
600 - National Instruments Virtual Bench initial support (@moritzj29)
601
602 Version 0.7 -- released 8/4/19
603 ==============================
604 - Dropped support for Python 3.4, adding support for Python 3.7
605 - Significant improvements to CI, dependencies, and conda environment (@bilderbuchi, @cjermain)
606 - Fix for PyQT issue in ResultsDialog (@CasperSchippers)
607 - Fix for wire validator in Keithley 2400 (@Fattotora)
608 - Addition of source_enabled control for Keithley 2400 (@dennisfeng2)
609 - Time constant fix and input controls for SR830 (@dennisfeng2)
610 - Added Keithley 2450 and Agilent 33521A (@hlgirard, @Endever42)
611 - Proper escaping support in CSV headers (@feph)
612 - Minor updates (@dvase)
613
614 Version 0.6.1 -- released 4/21/19
615 =================================
616 - Added Elektronica SM70-45D, Agilent 33220A, and Keysight N5767A instruments
617 (@CasperSchippers, @sumatrae)
618 - Fixes for Prologix adapter and Keithley 2400 (@hlgirard, @ronan-sensome)
619 - Improved support for SRS SR830 (@CasperSchippers)
620
621 Version 0.6 -- released 1/14/19
622 ===============================
623 - New VXI11 Adapter for ethernet instruments (@chweiser)
624 - PyQt updates to 5.6.0
625 - Added SRS SG380, Ametek 7270, Agilent 4156, HP 34401A, Advantest R3767CG, and
626 Oxford ITC503 instrustruments (@sylkar, @jmittelstaedt, @vik-s, @troylf, @CasperSchippers)
627 - Updates to Keithley 2000, Agilent 8257D, ESP 300, and Keithley 2400 instruments
628 (@watersjason, @jmittelstaedt, @nup002)
629 - Various minor bug fixes (@thosou)
630
631 Version 0.5.1 -- released 4/14/18
632 =================================
633 - Minor versions of PyVISA are now properly handled
634 - Documentation improvements (@Laogeodritt and @ederag)
635 - Instruments now have :code:`set_process` capability (@bilderbuchi)
636 - Plotter now uses threads (@dvspirito)
637 - Display inputs and PlotItem improvements (@Laogeodritt)
638
639 Version 0.5 -- released 10/18/17
640 ================================
641 - Threads are used by default, eliminating multiprocessing issues with spawn
642 - Enhanced unit tests for threading
643 - Sphinx Doctests are added to the documentation (@bilderbuchi)
644 - Improvements to documentation (@JuMaD)
645
646 Version 0.4.6 -- released 8/12/17
647 =================================
648 - Reverted multiprocessing start method keyword arguments to fix Unix spawn issues (@ndr37)
649 - Fixes to regressions in Results writing (@feinsteinben)
650 - Fixes to TCP support using cloudpickle (@feinsteinben)
651 - Restructing of unit test framework
652
653 Version 0.4.5 -- released 7/4/17
654 ================================
655 - Recorder and Scribe now leverage QueueListener (@feinsteinben)
656 - PrologixAdapter and SerialAdapter now handle Serial objects as adapters (@feinsteinben)
657 - Optional TCP support now uses cloudpickle for serialization (@feinsteinben)
658 - Significant PEP8 review and bug fixes (@feinsteinben)
659 - Includes docs in the code distribution (@ghisvail)
660 - Continuous integration support for Python 3.6 (@feinsteinben)
661
662 Version 0.4.4 -- released 6/4/17
663 ================================
664 - Fix pip install for non-wheel builds
665 - Update to Agilent E4980 (@dvspirito)
666 - Minor fixes for docs, tests, and formatting (@ghisvail, @feinsteinben)
667
668 Version 0.4.3 -- released 3/30/17
669 =================================
670 - Added Agilent E4980, AMI 430, Agilent 34410A, Thorlabs PM100, and
671 Anritsu MS9710C instruments (@TvBMcMaster, @dvspirito, and @mhdg)
672 - Updates to PyVISA support (@minhhaiphys)
673 - Initial work on resource manager (@dvspirito)
674 - Fixes for Prologix adapter that allow read-write delays (@TvBMcMaster)
675 - Fixes for conda environment on continuous integration
676
677 Version 0.4.2 -- released 8/23/16
678 =================================
679 - New instructions for installing with Anaconda and conda-forge package (thanks @melund!)
680 - Bug-fixes to the Keithley 2000, SR830, and Agilent E4408B
681 - Re-introduced the Newport ESP300 motion controller
682 - Major update to the Keithely 2400, 2000 and Yokogawa 7651 to achieve a common interface
683 - New command-string processing hooks for Instrument property functions
684 - Updated LakeShore 331 temperature controller with new features
685 - Updates to the Agilent 8257D signal generator for better feature exposure
686
687 Version 0.4.1 -- released 7/31/16
688 =================================
689 - Critical fix in setup.py for importing instruments (also added to documentation)
690
691 Version 0.4 -- released 7/29/16
692 ===============================
693 - Replaced Instrument add_measurement and add_control with measurement and control functions
694 - Added validators to allow Instrument.control to match restricted ranges
695 - Added mapping to Instrument.control to allow more flexible inputs
696 - Conda is now used to set up the Python environment
697 - macOS testing in continuous integration
698 - Major updates to the documentation
699
700 Version 0.3 -- released 4/8/16
701 ==============================
702 - Added IPython (Jupyter) notebook support with significant features
703 - Updated set of example scripts and notebooks
704 - New PyMeasure logo released
705 - Removed support for Python <3.4
706 - Changed multiprocessing to use spawn for compatibility
707 - Significant work on the documentation
708 - Added initial tests for non-instrument code
709 - Continuous integration setup for Linux and Windows
710
711 Version 0.2 -- released 12/16/15
712 ================================
713 - Python 3 compatibility, removed support for Python 2
714 - Considerable renaming for better PEP8 compliance
715 - Added MIT License
716 - Major restructuring of the package to break it into smaller modules
717 - Major rewrite of display functionality, introducing new Qt objects for easy extensions
718 - Major rewrite of procedure execution, now using a Worker process which takes advantage of multi-core CPUs
719 - Addition of a number of examples
720 - New methods for listening to Procedures, introducing ZMQ for TCP connectivity
721 - Updates to Keithley2400 and VISAAdapter
722
723 Version 0.1.6 -- released 4/19/15
724 =================================
725 - Renamed the package to PyMeasure from Automate to be more descriptive about its purpose
726 - Addition of VectorParameter to allow vectors to be input for Procedures
727 - Minor fixes for the Results and Danfysik8500
728
729 Version 0.1.5 -- release 10/22/14
730 =================================
731 - New Manager class for handling Procedures in a queue fashion
732 - New Browser that works in tandem with the Manager to display the queue
733 - Bug fixes for Results loading
734
735 Version 0.1.4 -- released 8/2/14
736 ================================
737 - Integrated Results class into display and file writing
738 - Bug fixes for Listener classes
739 - Bug fixes for SR830
740
741 Version 0.1.3 -- released 7/20/14
742 =================================
743 - Replaced logging system with Python logging package
744 - Added data management (Results) and bug fixes for Procedures and Parameters
745 - Added pandas v0.14 to requirements for data management
746 - Added data listeners, Qt4 and PyQtGraph helpers
747
748 Version 0.1.2 -- released 7/18/14
749 =================================
750 - Bug fixes to LakeShore 425
751 - Added new Procedure and Parameter classes for generic experiments
752 - Added version number in package
753
754 Version 0.1.1 -- released 7/16/14
755 =================================
756 - Bug fixes to PrologixAdapter, VISAAdapter, Agilent 8722ES, Agilent 8257D, Stanford SR830, Danfysik8500
757 - Added Tektronix TDS 2000 with basic functionality
758 - Fixed Danfysik communication to handle errors properly
759
760 Version 0.1.0 -- released 7/15/14
761 =================================
762 - Initial release