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