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   1/2 k_B T = 1/2 K x^2
   6 The analysis uses the expected power spectral density (PSD) of a
   7 damped simple harmonic oscillator to filter out noise from the
   8 measured PSD.
   9
  10
  11 Packages
  12 ========
  13
  14 Gentoo
  15 ------
  16
  17 I've packaged calibcant for Gentoo.  You need layman_ and my `wtk
  18 overlay`_.  Install with::
  19
  20     # emerge -av app-portage/layman
  21     # layman --add wtk
  22     # emerge -av sci-physics/calibcant
  23
  24 .. _layman: http://layman.sourceforge.net/
  25 .. _wtk overlay: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay/
  26
  27
  28 Dependencies
  29 ============
  30
  31 calibcant requires the following Python modules:
  32
  33 * linfit (depends in turn on scipy.stats.linregress)
  34 * TODO
  35
  36 * Numpy_
  37 * Scipy_
  38 * PyYAML_ (for saving and loading playlists)
  39 * Matplotlib_ (for generating plots)
  40 * wxPython_ (for the GUI)
  41
  42 .. _Python: http://www.python.org/
  43 .. _Numpy: http://numpy.scipy.org/
  44 .. _Scipy: http://www.scipy.org/
  45 .. _PyYAML: http://pyyaml.org/
  46 .. _Matplotlib: http://matplotlib.sourceforge.net/
  47 .. _wxPython: http://www.wxpython.org/
  48
  49
  50 Getting the source
  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 There are also periodic bundled releases.  For example, get version
  58 0.5 as a gzipped tarball with::
  59
  60      $ wget http://www.physics.drexel.edu/~wking/code/python/calibcant-0.5.tar.gz
  61      $ tar -xzvf calibcant-0.5.tar.gz
  62
  63 .. _Git: http://git-scm.com/
  64
  65
  66 Installation
  67 ============
  68
  69 After downloading, change to the source directory and run::
  70
  71     $ python setup.py install
  72
  73 to install calibcant.  Run::
  74
  75     $ python setup.py install --help
  76
  77 to see a list of installation options you may want to configure.
  78
  79
  80 Usage
  81 =====
  82
  83 You can... While there are a number of command-line scripts
  84 TODO