-Python modules to control piezoelectric actuators. Mostly a set of
-convenient wrappers around pycomedi calls for keeping track of the
-relevant calibration constants. To get a feel for an `official' set
-of calibration constants, you can take a peek at veeco_header, which
-is the beginning of a saved Veeco NanoScope image file. It lists the
-parameters used by the NanoScope during imaging.
+Pypiezo
+=======
-== Installation ==
+Pypiezo is a Python module to control piezoelectric actuators. It is
+mostly a set of convenient wrappers around pycomedi_ calls for keeping
+track of the relevant calibration constants. To get a feel for an
+"official" set of calibration constants, you can take a peek at
+`veeco_header`, which is the beginning of a saved Veeco NanoScope
+image file. It lists the parameters used by the NanoScope during
+imaging.
-Non-Python dependencies (Debian packagename):
- easy_install (python-setuptools)
- Numpy (python-numpy)
- Scipy (python-scipy)
- Matplotlib (python-matplotlib)
-Piezo uses `setuptools' for installation. Setuptools is basically an
-extension of the standard Python distutils package which supports
-automatic package dependency tracking. The installation procedure
-should be (on Debian-esque systems)
- # apt-get intall python-setuptools python-numpy python-scipy python-matplotlib
- # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ piezo
+Installation
+============
-There is one speedbump you might run into:
- * an outdated version of easy_install (see ez_setup.py section)
+Packages
+--------
-** ez_setup.py
+Gentoo
+~~~~~~
-This package bundles
- http://peak.telecommunity.com/dist/ez_setup.py
-to bootstrap setuputils installation on your machine (if neccessary).
+I've packaged pypiezo for Gentoo. You need layman_ and my `wtk
+overlay`_. Install with::
-If the bootstrapping doesn't work, you may need to install a current version
-of setuptools. On Debian-based systems `apt-get install python-setuptools'.
-Once you have *some* version of setuptools, upgrade with
- easy_install -U setuptools
+ # emerge -av app-portage/layman
+ # layman --add wtk
+ # emerge -av sci-libs/pypiezo
-For more information see
- http://peak.telecommunity.com/DevCenter/EasyInstall
- http://peak.telecommunity.com/DevCenter/setuptools#what-your-users-should-know
+Dependencies
+------------
-== Usage ==
+If you're installing by hand or packaging pypiezo for another
+distribution, you'll need the following dependencies:
-See piezo/z_piezo_utils.py for some simple examples.
+========================== ================= =============================================
+Package Debian_ Gentoo_
+========================== ================= =============================================
+Numpy_ python-numpy dev-python/numpy
+Scipy_ python-scipy sci-libs/scipy
+Matplotlib_ python-matplotlib dev-python/matplotlib
+H5config_ dev-python/h5config [#wtk]_
+Curses-check-for-keypress_ dev-python/curses-check-for-keypress [#wtk]_
+Nose_ python-nose dev-python/nose
+Pycomedi_ dev-python/pycomedi [#wtk]_
+========================== ================= =============================================
+.. [#wtk] In the `wtk overlay`_.
-== Licence ==
-This project is distributed under the GNU General Public Licence
-Version 3 or greater. See LICENSE.
+Installing by hand
+------------------
+Pypiezo is available as a Git_ repository::
-== Author ==
+ $ git clone git://tremily.us/pypiezo.git
+
+See the homepage_ for details. To install the checkout, run the
+standard::
+
+ $ python setup.py install
+
+
+Usage
+=====
+
+See the module docstrings for simple examples.
+
+
+Testing
+=======
+
+Run internal unit tests with::
+
+ $ nosetests --with-doctest --doctest-tests pypiezo
+
+
+Licence
+=======
+
+This project is distributed under the `GNU General Public License
+Version 3`_ or greater.
+
+
+Author
+======
W. Trevor King
-wking@drexel.edu
-Copyright 2007, 2008
+wking@tremily.us
+
+
+.. _layman: http://layman.sourceforge.net/
+.. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
+.. _Debian: http://www.debian.org/
+.. _Gentoo: http://www.gentoo.org/
+.. _NumPy: http://numpy.scipy.org/
+.. _SciPy: http://www.scipy.org/
+.. _Matplotlib: http://matplotlib.sourceforge.net/
+.. _H5config: http://blog.tremily.us/posts/h5config/
+.. _Curses-check-for-keypress:
+ http://blog.tremily.us/posts/curses-check-for-keypress/
+.. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
+.. _Pycomedi: http://blog.tremily.us/posts/pycomedi/
+.. _Git: http://git-scm.com/
+.. _homepage: http://blog.tremily.us/posts/pypiezo/
+.. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt
projects / pypiezo.git / blobdiff