README

   1 Pypiezo
   2 =======
   3
   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
  10 imaging.
  11
  12
  13 Installation
  14 ============
  15
  16 Packages
  17 --------
  18
  19 Gentoo
  20 ~~~~~~
  21
  22 I've packaged pypiezo for Gentoo.  You need layman_ and my `wtk
  23 overlay`_.  Install with::
  24
  25     # emerge -av app-portage/layman
  26     # layman --add wtk
  27     # emerge -av sci-libs/pypiezo
  28
  29
  30 Dependencies
  31 ------------
  32
  33 If you're installing by hand or packaging pypiezo for another
  34 distribution, you'll need the following dependencies:
  35
  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 ==========================  =================  =============================================
  47
  48 .. [#wtk] In the `wtk overlay`_.
  49
  50
  51 Installing by hand
  52 ------------------
  53
  54 Pypiezo is available as a Git_ repository::
  55
  56     $ git clone git://tremily.us/pypiezo.git
  57
  58 See the homepage_ for details.  To install the checkout, run the
  59 standard::
  60
  61     $ python setup.py install
  62
  63
  64 Usage
  65 =====
  66
  67 See the module docstrings for simple examples.
  68
  69
  70 Testing
  71 =======
  72
  73 Run internal unit tests with::
  74
  75     $ nosetests --with-doctest --doctest-tests pypiezo
  76
  77
  78 Licence
  79 =======
  80
  81 This project is distributed under the `GNU General Public License
  82 Version 3`_ or greater.
  83
  84
  85 Author
  86 ======
  87
  88 W. Trevor King
  89 wking@tremily.us
  90
  91
  92 .. _layman: http://layman.sourceforge.net/
  93 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
  94 .. _Debian: http://www.debian.org/
  95 .. _Gentoo: http://www.gentoo.org/
  96 .. _NumPy: http://numpy.scipy.org/
  97 .. _SciPy: http://www.scipy.org/
  98 .. _Matplotlib: http://matplotlib.sourceforge.net/
  99 .. _H5config: http://blog.tremily.us/posts/h5config/
 100 .. _Curses-check-for-keypress:
 101     http://blog.tremily.us/posts/curses-check-for-keypress/
 102 .. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
 103 .. _Pycomedi: http://blog.tremily.us/posts/pycomedi/
 104 .. _Git: http://git-scm.com/
 105 .. _homepage: http://blog.tremily.us/posts/pypiezo/
 106 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt