4 Pyafm is a set of tools for controlling atomic force microscopes. It
5 provides control of AFM postition using both short-range (piezo) and
6 long range (stepper) vertical positioning. There are separate modules
7 for controlling the piezo (`pypiezo`) and stepper (`stepper`), this
8 module mostly contains methods that require the capabilities of both.
16 I've packaged pyafm for Gentoo. You need layman_ and my `wtk
17 overlay`_. Install with::
19 # emerge -av app-portage/layman
21 # emerge -av sci-physics/pyafm
23 Although it is not strictly required (thanks to `duck typing`_) you'll
24 probably also want my `stepper`_ package or an equivalent
25 stepper implementation.
27 .. _layman: http://layman.sourceforge.net/
28 .. _wtk overlay: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay/
29 .. _duck typing: http://en.wikipedia.org/wiki/Duck_typing
30 .. _stepper: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/stepper/
36 Pyafm requires the following Python modules:
39 * Stepper_ (or equivalent stepper implementation)
41 .. _stepper: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/stepper/
42 .. _pypiezo: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pypiezo/
48 Pyafm is available as a Git_ repository::
50 $ git clone http://www.physics.drexel.edu/~wking/code/git/pyafm.git
52 There are also periodic bundled releases. For example, get version
53 0.1 as a gzipped tarball with::
55 $ wget http://www.physics.drexel.edu/~wking/code/python/pyafm-0.1.tar.gz
56 $ tar -xzvf pyafm-0.1.tar.gz
58 .. _Git: http://git-scm.com/
64 After downloading, change to the source directory and run::
66 $ python setup.py install
68 to install pyafm. Run::
70 $ python setup.py install --help
72 to see a list of installation options you may want to configure.