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   1/2 k_B T = 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 Dependencies
  30 ------------
  31
  32 If you're installing by hand or packaging calibcant for another
  33 distribution, you'll need the following dependencies:
  34
  35 ===========  =================  =====================
  36 Package      Debian_            Gentoo_
  37 ===========  =================  =====================
  38 Numpy_       python-numpy       dev-python/numpy
  39 Scipy_       python-scipy       sci-libs/scipy
  40 H5Py_        python-h5py        dev-python/h5py
  41 Matplotlib_  python-matplotlib  dev-python/matplotlib
  42 Nose_        python-nose        dev-python/nose
  43 FFT_tools_                      dev-python/FFT-tools
  44 Pypiezo_                        sci-libs/pypiezo
  45 ===========  =================  =====================
  46
  47 You'll also need my pyafm_ and stepper_ packages, or suitable
  48 replacements.
  49
  50 Installing by hand
  51 ------------------
  52
  53 Calibcant is available as a Git_ repository::
  54
  55     $ git clone http://www.physics.drexel.edu/~wking/code/git/calibcant.git
  56
  57 See the homepage_ for details.  To install the checkout, run the
  58 standard::
  59
  60     $ python setup.py install
  61
  62
  63 Usage
  64 =====
  65
  66 See the module docstrings for simple examples.
  67
  68
  69 Testing
  70 =======
  71
  72 Run internal unit tests with::
  73
  74     $ nosetests --with-doctest --doctest-tests calibcant
  75
  76
  77 Licence
  78 =======
  79
  80 This project is distributed under the `GNU General Public License
  81 Version 3`_ or greater.
  82
  83
  84 Author
  85 ======
  86
  87 W. Trevor King
  88 wking@drexel.edu
  89 Copyright 2007-2011
  90
  91
  92 .. _layman: http://layman.sourceforge.net/
  93 .. _wtk overlay:
  94      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay
  95 .. _Debian: http://www.debian.org/
  96 .. _Gentoo: http://www.gentoo.org/
  97 .. _NumPy: http://numpy.scipy.org/
  98 .. _SciPy: http://www.scipy.org/
  99 .. _H5Py: http://code.google.com/p/h5py/
 100 .. _Matplotlib: http://matplotlib.sourceforge.net/
 101 .. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
 102 .. _FFT_tools:
 103      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/FFT-tools/
 104 .. _Pypiezo:
 105      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pypiezo/
 106 .. _pyafm:
 107      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pyafm/
 108 .. _stepper:
 109      http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/stepper/
 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