From f16182920d23820d15cf2ba32f46768eac37db0d Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Thu, 15 Mar 2012 22:16:16 -0400 Subject: [PATCH] Update README and setup.py with new dependency information. --- README | 16 +++++++++++++--- setup.py | 3 ++- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/README b/README index 7ce783f..94b91c8 100644 --- 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/ diff --git a/setup.py b/setup.py index 89fb172..c03a624 100644 --- 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'], ) -- 2.26.2