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 .
To check for required and optional dependencies without actually installing:
python setup.py dry-check
TuLiP can be installed also from PyPI:
pip install tulip
Detailed instructions, including notes about dependencies and troubleshooting, are available at http://tulip-control.sourceforge.net/doc/install.html
The next section describes how to build documentation. A test suite is provided under tests/
. Consult the section "Testing" below.
There are two main sources of documentation outside the code. The "user" documentation is under doc/
and is built with Sphinx, so the usual steps apply, :
make html
API documentation is generated using Epydoc and can also be built from the doc
directory, now by :
make api
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., :
pydoc tulip
Tests are performed using nose. From the root of the source tree (i.e., where setup.py is located), :
./run_tests.py
to perform basic tests. To try all available tests, ./run_tests.py full
. For alternatives and a summary of usage, ./run_tests.py -h
This is free software released under the terms of the BSD 3-Clause License. There is no warranty; not even for merchantability or fitness for a particular purpose. Consult LICENSE for copying conditions.
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.