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 H5config_                       dev-python/h5config [#wtk]_
  41 H5Py_        python-h5py        dev-python/h5py
  42 Matplotlib_  python-matplotlib  dev-python/matplotlib
  43 Nose_        python-nose        dev-python/nose
  44 FFT_tools_                      dev-python/FFT-tools [#wtk]_
  45 Pypiezo_                        sci-libs/pypiezo [#wtk]_
  46 ===========  =================  ============================
  47
  48 .. [#wtk] In the `wtk overlay`_.
  49
  50 You'll also need my pyafm_ and stepper_ packages, or suitable
  51 replacements.
  52
  53 Installing by hand
  54 ------------------
  55
  56 Calibcant is available as a Git_ repository::
  57
  58     $ git clone git://tremily.us/calibcant.git
  59
  60 See the homepage_ for details.  To install the checkout, run the
  61 standard::
  62
  63     $ python setup.py install
  64
  65
  66 Usage
  67 =====
  68
  69 See the module docstrings for simple examples.
  70
  71
  72 Testing
  73 =======
  74
  75 Run internal unit tests with::
  76
  77     $ nosetests --with-doctest --doctest-tests calibcant
  78
  79
  80 Licence
  81 =======
  82
  83 This project is distributed under the `GNU General Public License
  84 Version 3`_ or greater.
  85
  86
  87 Author
  88 ======
  89
  90 W. Trevor King
  91 wking@drexel.edu
  92 Copyright 2007-2011
  93
  94
  95 .. _layman: http://layman.sourceforge.net/
  96 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
  97 .. _Debian: http://www.debian.org/
  98 .. _Gentoo: http://www.gentoo.org/
  99 .. _NumPy: http://numpy.scipy.org/
 100 .. _SciPy: http://www.scipy.org/
 101 .. _H5config: http://blog.tremily.us/posts/h5config/
 102 .. _H5Py: http://code.google.com/p/h5py/
 103 .. _Matplotlib: http://matplotlib.sourceforge.net/
 104 .. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
 105 .. _FFT_tools: http://blog.tremily.us/posts/FFT-tools/
 106 .. _Pypiezo: http://blog.tremily.us/posts/pypiezo/
 107 .. _pyafm: http://blog.tremily.us/posts/pyafm/
 108 .. _stepper: http://blog.tremily.us/posts/stepper/
 109 .. _Git: http://git-scm.com/
 110 .. _homepage: http://blog.tremily.us/posts/calibcant/
 111 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt