README

   1 Python modules to control piezoelectric actuators.  Mostly a set of
   2 convenient wrappers around pycomedi calls for keeping track of the
   3 relevant calibration constants.  To get a feel for an `official' set
   4 of calibration constants, you can take a peek at veeco_header, which
   5 is the beginning of a saved Veeco NanoScope image file.  It lists the
   6 parameters used by the NanoScope during imaging.
   7
   8 == Installation ==
   9
  10 Non-Python dependencies (Debian packagename):
  11   easy_install  (python-setuptools)
  12   Numpy         (python-numpy)
  13   Scipy         (python-scipy)
  14   Matplotlib    (python-matplotlib)
  15
  16 Piezo uses `setuptools' for installation.  Setuptools is basically an
  17 extension of the standard Python distutils package which supports
  18 automatic package dependency tracking.  The installation procedure
  19 should be (on Debian-esque systems)
  20   # apt-get intall python-setuptools python-numpy python-scipy python-matplotlib
  21   # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ piezo
  22
  23 There is one speedbump you might run into:
  24   * an outdated version of easy_install (see ez_setup.py section)
  25
  26 ** ez_setup.py
  27
  28 This package bundles
  29   http://peak.telecommunity.com/dist/ez_setup.py
  30 to bootstrap setuputils installation on your machine (if neccessary).
  31
  32 If the bootstrapping doesn't work, you may need to install a current version
  33 of setuptools.  On Debian-based systems `apt-get install python-setuptools'.
  34 Once you have *some* version of setuptools, upgrade with
  35   easy_install -U setuptools
  36
  37 For more information see
  38   http://peak.telecommunity.com/DevCenter/EasyInstall
  39   http://peak.telecommunity.com/DevCenter/setuptools#what-your-users-should-know
  40
  41
  42 == Usage ==
  43
  44 See piezo/z_piezo_utils.py for some simple examples.
  45
  46
  47 == Licence ==
  48
  49 This project is distributed under the GNU General Public Licence
  50 Version 3 or greater.  See LICENSE.
  51
  52
  53 == Author ==
  54
  55 W. Trevor King
  56 wking@drexel.edu
  57 Copyright 2007, 2008