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.
31 Pyafm requires the following Python modules:
34 * Stepper_ (or equivalent stepper implementation)
40 Pyafm is available as a Git_ repository::
42 $ git clone git://tremily.us/pyafm.git
44 There are also periodic bundled releases. For example, get version
45 0.3 as a gzipped tarball with::
47 $ wget 'http://git.tremily.us/?p=pyafm.git;a=snapshot;h=v0.3;sf=tgz'
48 $ tar -xzvf pyafm-0.1.tar.gz
54 After downloading, change to the source directory and run::
56 $ python setup.py install
58 to install pyafm. Run::
60 $ python setup.py install --help
62 to see a list of installation options you may want to configure.
71 .. _layman: http://layman.sourceforge.net/
72 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
73 .. _duck typing: http://en.wikipedia.org/wiki/Duck_typing
74 .. _stepper: http://blog.tremily.us/posts/stepper/
75 .. _pypiezo: http://blog.tremily.us/posts/pypiezo/
76 .. _Git: http://git-scm.com/