README

   1 pyafm: tools for controlling atomic force microscopes.
   2
   3 Provides control of AFM postition using both short-range (piezo) and
   4 long range (stepper) vertical positioning.  There are separate modules
   5 for controlling the piezo (`pypiezo`) and stepper (`stepper`), this
   6 module only contains methods that require the capabilities of both.
   7
   8 Packages
   9 ========
  10
  11 Gentoo
  12 ------
  13
  14 I've packaged pyafm for Gentoo.  You need layman_ and my `wtk
  15 overlay`_.  Install with::
  16
  17     # emerge -av app-portage/layman
  18     # layman --add wtk
  19     # emerge -av sci-physics/pyafm
  20
  21 Although it is not strictly required (thanks to `duck typing`_) you'll
  22 probably also want my `sci-libs/stepper`_ package or an equivalent
  23 stepper implementation.
  24
  25 .. _layman: http://layman.sourceforge.net/
  26 .. _wtk overlay: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay/
  27 .. _duck typing: http://en.wikipedia.org/wiki/Duck_typing
  28 .. _stepper: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/stepper/
  29
  30
  31 Dependencies
  32 ============
  33
  34 Pyafm requires the following Python modules:
  35
  36 * Pypiezo_
  37 * Stepper_ (or equivalent stepper implementation)
  38
  39 .. _stepper: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/stepper/
  40 .. _pypiezo: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pypiezo/
  41
  42
  43 Getting the source
  44 ==================
  45
  46 Pyafm is available as a Git_ repository::
  47
  48     $ git clone http://www.physics.drexel.edu/~wking/code/git/pyafm.git
  49
  50 There are also periodic bundled releases.  For example, get version
  51 0.1 as a gzipped tarball with::
  52
  53      $ wget http://www.physics.drexel.edu/~wking/code/python/pyafm-0.1.tar.gz
  54      $ tar -xzvf pyafm-0.1.tar.gz
  55
  56 .. _Git: http://git-scm.com/
  57
  58
  59 Installation
  60 ============
  61
  62 After downloading, change to the source directory and run::
  63
  64     $ python setup.py install
  65
  66 to install pyafm.  Run::
  67
  68     $ python setup.py install --help
  69
  70 to see a list of installation options you may want to configure.
  71
  72
  73 Usage
  74 =====
  75
  76 TODO