From: W. Trevor King Date: Wed, 27 Jul 2011 07:56:35 +0000 (-0400) Subject: Rename from tempcontrol to pypid (now that I'm moving to a more general framework). X-Git-Tag: v0.3~3 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=1c0ba189a20a643c2e29c9d66b5034f063288baa;p=pypid.git Rename from tempcontrol to pypid (now that I'm moving to a more general framework). --- diff --git a/README b/README index 2c52e9f..002968a 100644 --- a/README +++ b/README @@ -1,8 +1,8 @@ -This package provides an object-oriented interface for temperature -monitoring and PID_ control. The idea is that experimentalists -interested in temperature controlled experiments should not need to -learn the inner workings of their PID controller before they can -perform simple temperature control tasks. +This package provides general PID_ control software in Python with a +Melcor MTCA backend. The idea is that experimentalists interested in +temperature controlled experiments or other processes should not need +to learn the inner workings of their PID controller before they can +perform simple control tasks. Module structure ================ @@ -50,7 +50,7 @@ times to understand why you're getting instability or other control effects. Here's an example that shows a reasonable approach with a bit of integrator overshoot:: - >>> from tempcontrol.backend.test import TestBackend + >>> from pypid.backend.test import TestBackend >>> from time import sleep >>> from matplotlib import pyplot >>> from numpy import loadtxt @@ -90,17 +90,17 @@ Packages Gentoo ~~~~~~ -I've packaged `tempcontrol` for Gentoo_. You need layman_ and my `wtk +I've packaged `pypid` for Gentoo_. You need layman_ and my `wtk overlay`_. Install with:: # emerge -av app-portage/layman # layman --add wtk - # emerge -av dev-python/tempcontrol + # emerge -av dev-python/pypid Dependencies ------------ -If you're installing by hand or packaging `tempcontrol` for another +If you're installing by hand or packaging `pypid` for another distribution, you'll need the following dependencies: ========= ===================== ================ ========================== @@ -124,9 +124,9 @@ __ db578120_ Installing by hand ------------------ -Tempcontrol is available as a Git_ repository:: +Pypid is available as a Git_ repository:: - $ git clone http://www.physics.drexel.edu/~wking/code/git/tempcontrol.git + $ git clone http://www.physics.drexel.edu/~wking/code/git/pypid.git See the homepage_ for details. To install the checkout, run the standard:: @@ -143,7 +143,7 @@ Testing Run the test suite with:: - $ nosetests --with-doctest --doctest-tests tempcontrol + $ nosetests --with-doctest --doctest-tests pypid Note that you should have your temperature control device connected to your computer before running this command, as backend tests require a @@ -184,5 +184,5 @@ Copyright 2008-2011 .. _nose: http://somethingaboutorange.com/mrl/projects/nose/ .. _Git: http://git-scm.com/ .. _homepage: - http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/tempcontrol/ + http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pypid/ .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt diff --git a/tempcontrol/__init__.py b/pypid/__init__.py similarity index 84% rename from tempcontrol/__init__.py rename to pypid/__init__.py index 3391c48..e5e7f2e 100644 --- a/tempcontrol/__init__.py +++ b/pypid/__init__.py @@ -1,19 +1,19 @@ # Copyright (C) 2008-2011 W. Trevor King # -# This file is part of tempcontrol. +# This file is part of pypid. # -# tempcontrol is free software: you can redistribute it and/or +# pypid is free software: you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation, either # version 3 of the License, or (at your option) any later version. # -# tempcontrol is distributed in the hope that it will be useful, +# pypid is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public -# License along with tempcontrol. If not, see +# License along with pypid. If not, see # . import logging as _logging @@ -22,7 +22,7 @@ import logging as _logging __version__ = '0.3' -LOG = _logging.getLogger('tempcontrol') +LOG = _logging.getLogger('pypid') "Temperature-control logger" #LOG.setLevel(_logging.WARN) diff --git a/tempcontrol/backend/__init__.py b/pypid/backend/__init__.py similarity index 94% rename from tempcontrol/backend/__init__.py rename to pypid/backend/__init__.py index 36afd63..51cd544 100644 --- a/tempcontrol/backend/__init__.py +++ b/pypid/backend/__init__.py @@ -1,19 +1,19 @@ # Copyright (C) 2008-2011 W. Trevor King # -# This file is part of tempcontrol. +# This file is part of pypid. # -# tempcontrol is free software: you can redistribute it and/or +# pypid is free software: you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation, either # version 3 of the License, or (at your option) any later version. # -# tempcontrol is distributed in the hope that it will be useful, +# pypid is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public -# License along with tempcontrol. If not, see +# License along with pypid. If not, see # . """Assorted backends for interfacing with your particular hardware. @@ -22,10 +22,10 @@ def _import_by_name(modname): """ - >>> mod = _import_by_name('tempcontrol.backend.melcor') + >>> mod = _import_by_name('pypid.backend.melcor') >>> 'MelcorBackend' in dir(mod) True - >>> _import_by_name('tempcontrol.backend.highly_unlikely') + >>> _import_by_name('pypid.backend.highly_unlikely') Traceback (most recent call last): ... ImportError: No module named highly_unlikely diff --git a/tempcontrol/backend/melcor.py b/pypid/backend/melcor.py similarity index 99% rename from tempcontrol/backend/melcor.py rename to pypid/backend/melcor.py index 2f4f634..f0a5c92 100644 --- a/tempcontrol/backend/melcor.py +++ b/pypid/backend/melcor.py @@ -1,19 +1,19 @@ # Copyright (C) 2008-2011 W. Trevor King # -# This file is part of tempcontrol. +# This file is part of pypid. # -# tempcontrol is free software: you can redistribute it and/or +# pypid is free software: you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation, either # version 3 of the License, or (at your option) any later version. # -# tempcontrol is distributed in the hope that it will be useful, +# pypid is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public -# License along with tempcontrol. If not, see +# License along with pypid. If not, see # . import struct as _struct diff --git a/tempcontrol/backend/test.py b/pypid/backend/test.py similarity index 97% rename from tempcontrol/backend/test.py rename to pypid/backend/test.py index 0c627b0..826e881 100644 --- a/tempcontrol/backend/test.py +++ b/pypid/backend/test.py @@ -1,19 +1,19 @@ # Copyright (C) 2011 W. Trevor King # -# This file is part of tempcontrol. +# This file is part of pypid. # -# tempcontrol is free software: you can redistribute it and/or +# pypid is free software: you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation, either # version 3 of the License, or (at your option) any later version. # -# tempcontrol is distributed in the hope that it will be useful, +# pypid is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public -# License along with tempcontrol. If not, see +# License along with pypid. If not, see # . import threading as _threading diff --git a/tempcontrol/controller.py b/pypid/controller.py similarity index 98% rename from tempcontrol/controller.py rename to pypid/controller.py index 10400f1..43052ee 100644 --- a/tempcontrol/controller.py +++ b/pypid/controller.py @@ -1,19 +1,19 @@ # Copyright (C) 2008-2011 W. Trevor King # -# This file is part of tempcontrol. +# This file is part of pypid. # -# tempcontrol is free software: you can redistribute it and/or +# pypid is free software: you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation, either # version 3 of the License, or (at your option) any later version. # -# tempcontrol is distributed in the hope that it will be useful, +# pypid is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public -# License along with tempcontrol. If not, see +# License along with pypid. If not, see # . import time as _time @@ -34,7 +34,7 @@ from . import LOG as _LOG class Controller (object): """PID temperature control frontend. - backend: tempcontrol.backend.Backend instance + backend: pypid.backend.Backend instance backend driving your particular harware setpoint: float initial setpoint in degrees Celsius diff --git a/tempcontrol/test.py b/pypid/test.py similarity index 96% rename from tempcontrol/test.py rename to pypid/test.py index 7f9a671..c3b69f3 100644 --- a/tempcontrol/test.py +++ b/pypid/test.py @@ -1,19 +1,19 @@ # Copyright (C) 2008-2011 W. Trevor King # -# This file is part of tempcontrol. +# This file is part of pypid. # -# tempcontrol is free software: you can redistribute it and/or +# pypid is free software: you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation, either # version 3 of the License, or (at your option) any later version. # -# tempcontrol is distributed in the hope that it will be useful, +# pypid is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public -# License along with tempcontrol. If not, see +# License along with pypid. If not, see # . "Basic testing for `Controller`\s and `Backend`\s" diff --git a/setup.py b/setup.py index 93c9671..cf4d014 100644 --- a/setup.py +++ b/setup.py @@ -1,27 +1,27 @@ -"""A modular temperature control library. +"""A modular PID control library. """ from distutils.core import setup import os.path -from tempcontrol import __version__ +from pypid import __version__ _this_dir = os.path.dirname(__file__) base_url = 'http://physics.drexel.edu/~wking' -setup(name='tempcontrol', +setup(name='pypid', version=__version__, maintainer='W. Trevor King', maintainer_email='wking@drexel.edu', - url = '{}/unfolding-disasters/posts/tempcontrol'.format(base_url), - download_url = '{}/code/python/tempcontrol-{}.tar.gz'.format( + url = '{}/unfolding-disasters/posts/pypid'.format(base_url), + download_url = '{}/code/python/pypid-{}.tar.gz'.format( base_url, __version__), license = 'GNU General Public License (GPL)', platforms = ['all'], description = __doc__, long_description = open(os.path.join(_this_dir, 'README'), 'r').read(), - packages=['tempcontrol', 'tempcontrol.backend'], + packages=['pypid', 'pypid.backend'], classifiers = [ 'Development Status :: 2 - Pre-Alpha', 'Intended Audience :: Developers',