Calculates the spring constant `k` of a cantilever using the
equipartition theorem:
- 1/2 k_B T = 1/2 K x^2
+
+.. math:: \frac{1}{2} k_B T = \frac{1}{2} K x^2
+
The analysis uses the expected power spectral density (PSD) of a
damped simple harmonic oscillator to filter out noise from the
measured PSD.
+Installation
+============
+
Packages
-========
+--------
Gentoo
-------
+~~~~~~
I've packaged calibcant for Gentoo. You need layman_ and my `wtk
overlay`_. Install with::
Dependencies
-============
+------------
-calibcant requires the following Python modules:
+If you're installing by hand or packaging calibcant for another
+distribution, you'll need the following dependencies:
-* linfit (depends in turn on scipy.stats.linregress)
-* TODO
+=========== ================= =====================
+Package Debian_ Gentoo_
+=========== ================= =====================
+Numpy_ python-numpy dev-python/numpy
+Scipy_ python-scipy sci-libs/scipy
+H5Py_ python-h5py dev-python/h5py
+Matplotlib_ python-matplotlib dev-python/matplotlib
+Nose_ python-nose dev-python/nose
+FFT_tools_ dev-python/FFT-tools
+Pypiezo_ sci-libs/pypiezo
+=========== ================= =====================
-* Numpy_
-* Scipy_
-* PyYAML_ (for saving and loading playlists)
-* Matplotlib_ (for generating plots)
-* wxPython_ (for the GUI)
+You'll also need my pyafm_ and stepper_ packages, or suitable
+replacements.
-.. _Python: http://www.python.org/
-.. _Numpy: http://numpy.scipy.org/
-.. _Scipy: http://www.scipy.org/
-.. _PyYAML: http://pyyaml.org/
-.. _Matplotlib: http://matplotlib.sourceforge.net/
-.. _wxPython: http://www.wxpython.org/
+Installing by hand
+------------------
+Calibcant is available as a Git_ repository::
-Getting the source
-==================
+ $ git clone http://www.physics.drexel.edu/~wking/code/git/calibcant.git
-calibcant is available as a Git_ repository::
+See the homepage_ for details. To install the checkout, run the
+standard::
- $ git clone http://www.physics.drexel.edu/~wking/code/git/calibcant.git
+ $ python setup.py install
-There are also periodic bundled releases. For example, get version
-0.5 as a gzipped tarball with::
- $ wget http://www.physics.drexel.edu/~wking/code/python/calibcant-0.5.tar.gz
- $ tar -xzvf calibcant-0.5.tar.gz
+Usage
+=====
-.. _Git: http://git-scm.com/
+See the module docstrings for simple examples.
-Installation
-============
+Testing
+=======
-After downloading, change to the source directory and run::
+Run internal unit tests with::
- $ python setup.py install
+ $ nosetests --with-doctest --doctest-tests calibcant
-to install calibcant. Run::
- $ python setup.py install --help
+Licence
+=======
-to see a list of installation options you may want to configure.
+This project is distributed under the `GNU General Public License
+Version 3`_ or greater.
-Usage
-=====
+Author
+======
-You can... While there are a number of command-line scripts
-TODO
+W. Trevor King
+wking@drexel.edu
+Copyright 2007-2011
+
+
+.. _layman: http://layman.sourceforge.net/
+.. _wtk overlay:
+ http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay
+.. _Debian: http://www.debian.org/
+.. _Gentoo: http://www.gentoo.org/
+.. _NumPy: http://numpy.scipy.org/
+.. _SciPy: http://www.scipy.org/
+.. _H5Py: http://code.google.com/p/h5py/
+.. _Matplotlib: http://matplotlib.sourceforge.net/
+.. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
+.. _FFT_tools:
+ http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/FFT-tools/
+.. _Pypiezo:
+ http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pypiezo/
+.. _Git: http://git-scm.com/
+.. _homepage:
+ http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/calibcant/
+.. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt
projects / calibcant.git / blobdiff