README

changeset 94
1ac1457af83f
parent 91
f2a8f688dbc0
equal deleted inserted replaced
93:b459d4bc07cf 94:1ac1457af83f
1 pygpibtoolkit is (c) 2007-2018 David Douard 1 ===============
2 pygpibtoolkit
3 ===============
4
5 pygpibtoolkit_ is a pure Python 3 toolkit for managing and controlling test
6 equipment via the GPIB_ (aka IEEE-488) bus.
7
8 Currently, it only supports Prologix_ compatible GPIB dongles, but support for
9 linux-gpib_ is planned.
10
11 Installation
12 ============
13
14 The simplest way to install pygpibtoolkit_ is to use pip_. I strongly recommend
15 you use virtualenvs_ for this, for example via virtualenvwrapper_ or pew_. Here
16 is an example session using virtualenvwrapper_ on a Debian stretch machine:
17
18 .. code-block:: bash
19
20 david@host:~$ mkvirtualenv -p /usr/bin/python3 pygpib
21 Already using interpreter /usr/bin/python3
22 Using base prefix '/usr'
23 New python executable in /home/david/.virtualenvs/pygpib/bin/python3
24 Also creating executable in /home/david/.virtualenvs/pygpib/bin/python
25 Installing setuptools, pkg_resources, pip, wheel...done.
26
27 (pygpib) david@host:~$ pip install pygpibtoolkit
28 [...]
29 Installing collected packages: pyserial, numpy, sip, PyQt5, pyqtgraph, pygpibtoolkit
30 Successfully installed PyQt5-5.10.1 numpy-1.14.3 pygpibtoolkit-0.1.0 pyqtgraph-0.10.0 pyserial-3.4 sip-4.19.8
31 (pygpib) david@pavo:~$ pygpib-detect --help
32 usage: A simple tool for detecting connected GPIB devices [-h] [-d DEVICE] [-v]
33
34 optional arguments:
35 -h, --help show this help message and exit
36 -d DEVICE, --device DEVICE
37 Device of connected Prologix GPIB bundle
38 [/dev/ttyUSB0]
39 -v, --verbose
40 (pygpib) david@host:~$ python
41 Python 3.5.3 (default, Jan 19 2017, 14:11:04)
42 [GCC 6.3.0 20170118] on linux
43 Type "help", "copyright", "credits" or "license" for more information.
44 >>> from pygpibtoolkit.prologix import GPIB
45 >>> from pygpibtoolkit.gpibcontroller import GPIBController
46 >>> cnx = GPIB(device='/dev/ttyUSB0')
47 >>> ctl = GPIBController(cnx)
48 >>> dvm = c.register_device(24, "HP3456A")
49 >>> dvm.S0F1 # set DVM to DC Voltage mode
50
51
52
53 Please refer to the `user manual`_ for more informations on how to use the
54 provided tools and how to use the API.
55
56
57
58 You can get information on pygpibtoolkit on
59 http://pygpibtoolkit.readthedocs.io
60
61 The project is hosted at
62 https://bitbucket.org/dddouard/pygpibtoolkit
63
64 If you have any questions, please mail david.douard@sdfa3.org for support.
65
66 pygpibtoolkit_ is (c) 2007-2018 David Douard
2 and is available under the GNU General Public Licence v2. 67 and is available under the GNU General Public Licence v2.
3 68
4 You can get information on pygpibtoolkit on 69 .. _pygpibtoolkit: http://pygpibtoolkit.readthedocs.io
5 https://bitbucket.org/dddouard/pygpibtoolkit 70 .. _`user manual`: http://pygpibtoolkit.readthedocs.io
6 71 .. _GPIB: https://en.wikipedia.org/wiki/IEEE-488
7 See `doc/introduction.rst` for a quick overview. 72 .. _Prologix: http://prologix.biz
8 73 .. _linux-gpib: https://linux-gpib.sourceforge.io
9 If you have any questions, please mail david.douard@sdfa3.org for support. 74 .. _virtualenvs: https://docs.python.org/dev/library/venv.html
75 .. _pip: https://packaging.python.org/key_projects/#pip
76 .. _virtualenvwrapper: http://virtualenvwrapper.readthedocs.io
77 .. _pew: https://github.com/berdario/pew

mercurial