This is the source repository for TuLiP, the temporal logic planning toolbox. The project website is http://tulip-control.org
In most cases, it suffices to::
pip install .
TuLiP can be installed also
from PyPI <https://pypi.python.org/pypi/tulip>_::
pip install tulip
This will install the latest release, together with required dependencies. To find out what dependencies (including optional ones) are installed, call::
For detailed instructions, including notes about dependencies and troubleshooting,
The next section describes how to build documentation.
A test suite is provided under
tests/. Consult the section "Testing" below.
Pip can install the latest development snapshot too::
Code under development can be unstable so trying
pip install tulip first
There are two main sources of documentation outside the code. The "user"
documentation is under
doc/ and is built with
Sphinx <http://sphinx.pocoo.org/>_, so the usual steps apply, ::
API documentation is generated using
and can also be built from the
doc directory, now by ::
Built copies for the most recent release of TuLiP are available online at:
Command summaries are provided by
make help. Besides the above sources, you
may also read API documentation using the standard pydoc tool. E.g., ::
Tests are performed using
nose <http://readthedocs.org/docs/nose/>_. From the
root of the source tree (i.e., where
setup.py is located), ::
to perform basic tests. To try all available tests,
For alternatives and a summary of usage,
tulip-control-users mailing list <https://sourceforge.net/p/tulip-control/mailman/tulip-control-users>_
tulip-control-announce mailing list <https://sourceforge.net/p/tulip-control/mailman/tulip-control-announce>_
This is free software released under the terms of
the BSD 3-Clause License <http://opensource.org/licenses/BSD-3-Clause>_. There is no warranty; not even
for merchantability or fitness for a particular purpose. Consult LICENSE for
When code is modified or re-distributed, the LICENSE file should accompany the code or any subset of it, however small. As an alternative, the LICENSE text can be copied within files, if so desired.