Update README and setup.py with new dependency information.
authorW. Trevor King <wking@drexel.edu>
Fri, 16 Mar 2012 02:16:16 +0000 (22:16 -0400)
committerW. Trevor King <wking@drexel.edu>
Fri, 16 Mar 2012 02:16:16 +0000 (22:16 -0400)
README
setup.py

diff --git a/README b/README
index 7ce783fde5a2d701065e9a1921ab43751e698f4d..94b91c855aaad639cb20298106e109b61b814300 100644 (file)
--- a/README
+++ b/README
@@ -4,9 +4,12 @@ Pyafm
 Pyafm is a set of tools for controlling atomic force microscopes.  It
 provides control of AFM postition using both short-range (piezo) and
 long range (stepper) vertical positioning.  There are separate modules
-for controlling the piezo (`pypiezo`) and stepper (`stepper`), this
+for controlling the piezo (pypiezo_) and stepper (stepper_), this
 module mostly contains methods that require the capabilities of both.
 
+This module can optionally include temperature sensing via a pypid_
+backend.
+
 Packages
 ========
 
@@ -30,9 +33,12 @@ Dependencies
 
 Pyafm requires the following Python modules:
 
+* Pycomedi_ (required directly, and via ``pypiezo``)
 * Pypiezo_
 * Stepper_ (or equivalent stepper implementation)
-
+* Pypid_ (optional temperature monitoring and control)
+* H5config_
+* SciPy_
 
 Getting the source
 ==================
@@ -71,6 +77,10 @@ TODO
 .. _layman: http://layman.sourceforge.net/
 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
 .. _duck typing: http://en.wikipedia.org/wiki/Duck_typing
-.. _stepper: http://blog.tremily.us/posts/stepper/
+.. _pycomedi: http://blog.tremily.us/posts/pycomedi/
 .. _pypiezo: http://blog.tremily.us/posts/pypiezo/
+.. _stepper: http://blog.tremily.us/posts/stepper/
+.. _pypid: http://blog.tremily.us/posts/pypid/
+.. _h5config: http://blog.tremily.us/posts/h5config/
+.. _SciPy: http://www.scipy.org/
 .. _Git: http://git-scm.com/
index 89fb172049a4cd8cccf5bb5ef2b9e4b8ac0ce038..c03a624be81859fb423de15930033a265756d88d 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -36,5 +36,6 @@ setup(name=package_name,
       classifiers=filter(None, classifiers.split('\n')),
       packages=['pyafm'],
       provides=['pyafm (%s)' % __version__],
-      requires=['pypiezo (>= 0.6)'],
+      requires=[
+        'pypiezo (>= 0.6)', 'stepper (>= 0.3)', 'h5config (>= 0.2)', 'scipy'],
       )