README

   1 calibcant: tools for thermally calibrating AFM cantilevers
   2
   3 Calculates the spring constant `k` of a cantilever using the
   4 equipartition theorem:
   5
   6 .. math::  \frac{1}{2} k_B T = \frac{1}{2} K x^2
   7
   8 The analysis uses the expected power spectral density (PSD) of a
   9 damped simple harmonic oscillator to filter out noise from the
  10 measured PSD.
  11
  12
  13 Installation
  14 ============
  15
  16 Packages
  17 --------
  18
  19 Gentoo
  20 ~~~~~~
  21
  22 I've packaged calibcant 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-physics/calibcant
  28
  29 .. _layman: http://layman.sourceforge.net/
  30 .. _wtk overlay: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay/
  31
  32
  33 Dependencies
  34 ------------
  35
  36 If you're installing by hand or packaging calibcant for another
  37 distribution, you'll need the following dependencies:
  38
  39 ===========  =================  =====================
  40 Package      Debian_            Gentoo_
  41 ===========  =================  =====================
  42 Numpy_       python-numpy       dev-python/numpy
  43 Scipy_       python-scipy       sci-libs/scipy
  44 H5Py_        python-h5py        dev-python/h5py
  45 Matplotlib_  python-matplotlib  dev-python/matplotlib
  46 Nose_        python-nose        dev-python/nose
  47 FFT_tools_                      dev-python/FFT-tools
  48 Pypiezo_                        sci-libs/pypiezo
  49 ===========  =================  =====================
  50
  51 You'll also need my pyafm_ and stepper_ packages, or suitable
  52 replacements.
  53
  54 Installing by hand
  55 ------------------
  56
  57 Calibcant is available as a Git_ repository::
  58
  59     $ git clone http://www.physics.drexel.edu/~wking/code/git/calibcant.git
  60
  61 See the homepage_ for details.  To install the checkout, run the
  62 standard::
  63
  64     $ python setup.py install
  65
  66
  67 Usage
  68 =====
  69
  70 See the module docstrings for simple examples.
  71
  72
  73 Testing
  74 =======
  75
  76 Run internal unit tests with::
  77
  78     $ nosetests --with-doctest --doctest-tests calibcant
  79
  80
  81 Licence
  82 =======
  83
  84 This project is distributed under the `GNU General Public License
  85 Version 3`_ or greater.
  86
  87
  88 Author
  89 ======
  90
  91 W. Trevor King
  92 wking@drexel.edu
  93 Copyright 2007-2011
  94
  95
  96 .. _layman: http://layman.sourceforge.net/
  97 .. _wtk overlay:
  98      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay
  99 .. _Debian: http://www.debian.org/
 100 .. _Gentoo: http://www.gentoo.org/
 101 .. _NumPy: http://numpy.scipy.org/
 102 .. _SciPy: http://www.scipy.org/
 103 .. _H5Py: http://code.google.com/p/h5py/
 104 .. _Matplotlib: http://matplotlib.sourceforge.net/
 105 .. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
 106 .. _FFT_tools:
 107      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/FFT-tools/
 108 .. _Pypiezo:
 109      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pypiezo/
 110 .. _Git: http://git-scm.com/
 111 .. _homepage:
 112      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/calibcant/
 113 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt