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 run all available tests. For a summary of usage, ./run_tests.py -h