4 Pypiezo is a Python module to control piezoelectric actuators. It is
5 mostly a set of convenient wrappers around pycomedi_ calls for keeping
6 track of the relevant calibration constants. To get a feel for an
7 "official" set of calibration constants, you can take a peek at
8 `veeco_header`, which is the beginning of a saved Veeco NanoScope
9 image file. It lists the parameters used by the NanoScope during
22 I've packaged pypiezo for Gentoo. You need layman_ and my `wtk
23 overlay`_. Install with::
25 # emerge -av app-portage/layman
27 # emerge -av sci-libs/pypiezo
33 If you're installing by hand or packaging pypiezo for another
34 distribution, you'll need the following dependencies:
36 ========================== ================= =============================================
37 Package Debian_ Gentoo_
38 ========================== ================= =============================================
39 Numpy_ python-numpy dev-python/numpy
40 Scipy_ python-scipy sci-libs/scipy
41 Matplotlib_ python-matplotlib dev-python/matplotlib
42 H5config_ dev-python/h5config [#wtk]_
43 Curses-check-for-keypress_ dev-python/curses-check-for-keypress [#wtk]_
44 Nose_ python-nose dev-python/nose
45 Pycomedi_ dev-python/pycomedi [#wtk]_
46 ========================== ================= =============================================
48 .. [#wtk] In the `wtk overlay`_.
54 Pypiezo is available as a Git_ repository::
56 $ git clone git://tremily.us/pypiezo.git
58 See the homepage_ for details. To install the checkout, run the
61 $ python setup.py install
67 See the module docstrings for simple examples.
73 Run internal unit tests with::
75 $ nosetests --with-doctest --doctest-tests pypiezo
81 This project is distributed under the `GNU General Public License
82 Version 3`_ or greater.
93 .. _layman: http://layman.sourceforge.net/
94 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
95 .. _Debian: http://www.debian.org/
96 .. _Gentoo: http://www.gentoo.org/
97 .. _NumPy: http://numpy.scipy.org/
98 .. _SciPy: http://www.scipy.org/
99 .. _Matplotlib: http://matplotlib.sourceforge.net/
100 .. _H5config: http://blog.tremily.us/posts/h5config/
101 .. _Curses-check-for-keypress:
102 http://blog.tremily.us/posts/curses-check-for-keypress/
103 .. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
104 .. _Pycomedi: http://blog.tremily.us/posts/pycomedi/
105 .. _Git: http://git-scm.com/
106 .. _homepage: http://blog.tremily.us/posts/pypiezo/
107 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt