https://github.com/tulip-control/tulip-control

Temporal Logic Planning toolbox
https://github.com/tulip-control/tulip-control

abstraction automata control-systems feedback-systems hybrid-systems python specification state-machine synthesis temporal-logic verification

Last synced: about 1 year ago
JSON representation

Temporal Logic Planning toolbox

• Host: GitHub
• URL: https://github.com/tulip-control/tulip-control
• Owner: tulip-control
• License: bsd-3-clause
• Created: 2013-10-30T17:15:55.000Z (over 12 years ago)
• Default Branch: main
• Last Pushed: 2024-11-30T21:43:31.000Z (over 1 year ago)
• Last Synced: 2025-04-03T14:12:44.680Z (about 1 year ago)
• Topics: abstraction, automata, control-systems, feedback-systems, hybrid-systems, python, specification, state-machine, synthesis, temporal-logic, verification
• Language: Python
• Homepage: http://tulip-control.org
• Size: 9.52 MB
• Stars: 117
• Watchers: 15
• Forks: 35
• Open Issues: 66
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Citation: CITATION.cff
  • Authors: AUTHORS

Awesome Lists containing this project

README

          
TuLiP

=====

This is the source repository for TuLiP, the temporal logic planning toolbox.

The project website is http://tulip-control.org

Installation

------------

In most cases, it suffices to::

  pip install .

TuLiP can be installed also `from PyPI `_::

  pip install tulip

This will install the latest release, together with required dependencies.

To find out what dependencies (including optional ones) are installed, call::

  tulip.interfaces.print_env()

For detailed instructions, including notes about dependencies and troubleshooting,

consult https://tulip-control.sourceforge.io/doc/install.html

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::

  pip install https://github.com/tulip-control/tulip-control/archive/master.zip

Code under development can be unstable so trying `pip install tulip` first

is recommended.

Documentation

-------------

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:

* https://tulip-control.sourceforge.io/doc/

* https://tulip-control.sourceforge.io/api-doc/

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

Testing

-------

Tests are performed using `pytest `_.  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``

Contact and support

-------------------

* Ask for help on the `tulip-control-users mailing list `_

* For release announcements, join the `tulip-control-announce mailing list `_

* Bug reports and feature requests should be made at https://github.com/tulip-control/tulip-control/issues

  Please check for prior discussion and reports before opening a new issue.

License

-------

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.

If this software is useful to you, we kindly ask that you cite us::

  I. Filippidis, S. Dathathri, S. C. Livingston, N. Ozay and R. M. Murray,

  "Control design for hybrid systems with TuLiP: The Temporal Logic Planning

  toolbox," 2016 IEEE Conference on Control Applications (CCA), Buenos Aires,

  Argentina, 2016, pp. 1030-1041, doi: 10.1109/CCA.2016.7587949.