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 pypiezo 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/pypiezo
  26
  27
  28 Dependencies
  29 ------------
  30
  31 If you're installing by hand or packaging pypiezo 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 H5Py_        python-h5py        dev-python/h5py
  40 Matplotlib_  python-matplotlib  dev-python/matplotlib
  41 Nose_        python-nose        dev-python/nose
  42 Pycomedi_                       dev-python/pycomedi
  43 PyYAML_      python-pyyaml      dev-python/pyyaml
  44 ===========  =================  =====================
  45
  46
  47 Installing by hand
  48 ------------------
  49
  50 Pypiezo is available as a Git_ repository::
  51
  52     $ git clone http://www.physics.drexel.edu/~wking/code/git/pypiezo.git
  53
  54 See the homepage_ for details.  To install the checkout, run the
  55 standard::
  56
  57     $ python setup.py install
  58
  59
  60 Usage
  61 =====
  62
  63 See the module docstrings for simple examples.
  64
  65
  66 Testing
  67 =======
  68
  69 Run internal unit tests with::
  70
  71     $ nosetests --with-doctest --doctest-tests pypiezo
  72
  73
  74 Licence
  75 =======
  76
  77 This project is distributed under the `GNU General Public License
  78 Version 3`_ or greater.
  79
  80
  81 Author
  82 ======
  83
  84 W. Trevor King
  85 wking@drexel.edu
  86 Copyright 2007-2011
  87
  88
  89 .. _layman: http://layman.sourceforge.net/
  90 .. _wtk overlay:
  91      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay
  92 .. _Debian: http://www.debian.org/
  93 .. _Gentoo: http://www.gentoo.org/
  94 .. _NumPy: http://numpy.scipy.org/
  95 .. _SciPy: http://www.scipy.org/
  96 .. _H5Py: http://code.google.com/p/h5py/
  97 .. _Matplotlib: http://matplotlib.sourceforge.net/
  98 .. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
  99 .. _PyYAML: http://pyyaml.org/wiki/PyYAML
 100 .. _Git: http://git-scm.com/
 101 .. _homepage:
 102      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pypiezo/
 103 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt