README

   1 Pypiezo: Python modules to control piezoelectric actuators.
   2
   3 Mostly a set of convenient wrappers around pycomedi calls for keeping
   4 track of the relevant calibration constants.  To get a feel for an
   5 "official" set of calibration constants, you can take a peek at
   6 `veeco_header`, which is the beginning of a saved Veeco NanoScope
   7 image file.  It lists the parameters used by the NanoScope during
   8 imaging.
   9
  10
  11 Installation
  12 ============
  13
  14 Packages
  15 --------
  16
  17 Gentoo
  18 ~~~~~~
  19
  20 I've packaged FFT-tools for Gentoo.  You need layman_ and my `wtk
  21 overlay`_.  Install with::
  22
  23     # emerge -av app-portage/layman
  24     # layman --add wtk
  25     # emerge -av sci-libs/pycomedi
  26
  27
  28 Dependencies
  29 ------------
  30
  31 If you're installing by hand or packaging pycomedi for another
  32 distribution, you'll need the following dependencies:
  33
  34 ===========  =================  =====================
  35 Package      Debian_            Gentoo_
  36 ===========  =================  =====================
  37 Numpy_       python-numpy       dev-python/numpy
  38 Scipy_       python-scipy       sci-libs/scipy
  39 Matplotlib_  python-matplotlib  dev-python/matplotlib
  40 Nose_        python-nose        dev-python/nose
  41 Pycomedi_                       dev-python/pycomedi
  42 ===========  =================  =====================
  43
  44
  45 Installing by hand
  46 ------------------
  47
  48 Pypiezo is available as a Git_ repository::
  49
  50     $ git clone http://www.physics.drexel.edu/~wking/code/git/pypiezo.git
  51
  52 See the homepage_ for details.  To install the checkout, run the
  53 standard::
  54
  55     $ python setup.py install
  56
  57
  58 Usage
  59 =====
  60
  61 See the module docstrings for simple examples.
  62
  63
  64 Testing
  65 =======
  66
  67 Run internal unit tests with::
  68
  69     $ nosetests --with-doctest --doctest-tests pypiezo
  70
  71
  72 Licence
  73 =======
  74
  75 This project is distributed under the `GNU General Public License
  76 Version 3`_ or greater.
  77
  78
  79 Author
  80 ======
  81
  82 W. Trevor King
  83 wking@drexel.edu
  84 Copyright 2007-2011
  85
  86
  87 .. _layman: http://layman.sourceforge.net/
  88 .. _wtk overlay:
  89      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay
  90 .. _Debian: http://www.debian.org/
  91 .. _Gentoo: http://www.gentoo.org/
  92 .. _NumPy: http://numpy.scipy.org/
  93 .. _SciPy: http://www.scipy.org/
  94 .. _Matplotlib: http://matplotlib.sourceforge.net/
  95 .. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
  96 .. _Git: http://git-scm.com/
  97 .. _homepage:
  98      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pypiezo/
  99 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt