This package provides Python control of stepper motors. See Jones'
-"Control of Stepping Motors" for an excellent stepper overview.
- http://www.cs.uiowa.edu/~jones/step/
+`Control of Stepping Motors`_ for an excellent stepper overview.
Supports full and half stepping of motors with one or two power lines
-and 4 drains, or one or two drains and 4 power lines... Basically any
+and 4 drains, or one or two drains and 4 power lines. Basically any
motor with 4 variable lines, and it would be easy to extend it to
other cases.
-== Installation ==
-Non-Python dependencies (Debian packagename):
- easy_install (python-setuptools)
+Installation
+============
-Stepper 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-dev
- # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ stepper
+Packages
+--------
-There is one speedbump you might run into:
- * an outdated version of easy_install (see ez_setup.py section)
+Gentoo
+~~~~~~
-** ez_setup.py
+I've packaged stepper for Gentoo. You need layman_ and my `wtk
+overlay`_. Install with::
-This package bundles
- http://peak.telecommunity.com/dist/ez_setup.py
-to bootstrap setuputils installation on your machine (if neccessary).
+ # emerge -av app-portage/layman
+ # layman --add wtk
+ # emerge -av sci-libs/stepper
-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
-For more information see
- http://peak.telecommunity.com/DevCenter/EasyInstall
- http://peak.telecommunity.com/DevCenter/setuptools#what-your-users-should-know
+Dependencies
+------------
+Stepper has no explicit dependencies outside of the core Python
+modules, but for real-world results you will need a way to drive the
+stepper's digital control lines. A general way to do this is with the
+pycomedi wrapper around the Comedilib_ library, as shown in the
+Stepper doctest.
-== Usage ==
+You will also need nose for testing.
-See the tests in FFT_tools.py for simple examples.
+=========== ================= =====================
+Package Debian_ Gentoo_
+=========== ================= =====================
+Nose_ python-nose dev-python/nose
+Pycomedi_ dev-python/pycomedi
+=========== ================= =====================
-== Licence ==
+Installing by hand
+------------------
-This project is distributed under the BSD License.
- http://www.fsf.org/licensing/licenses/#ModifiedBSD
+Stepper is available as a Git_ repository::
+ $ git clone git://tremily.us/stepper.git
-== Author ==
+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 stepper.py
+
+
+Licence
+=======
+
+This project is distributed under the `GNU General Public License
+Version 3`_ or greater.
+
+
+Author
+======
W. Trevor King
-wking@drexel.edu
-Copyright 2008, 2009
+wking@tremily.us
+Copyright 2008-2012
+
+
+.. _Control of Stepping Motors: http://www.cs.uiowa.edu/~jones/step/
+.. _layman: http://layman.sourceforge.net/
+.. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
+.. _Debian: http://www.debian.org/
+.. _Gentoo: http://www.gentoo.org/
+.. _Comedilib: http://www.comedi.org/
+.. _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/stepper/
+.. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt
projects / stepper.git / blobdiff