tulip

Temporal Logic Planning toolbox

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

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 1 DOI reference(s) in README
○
Academic publication links
✓
Committers with academic emails
15 of 29 committers (51.7%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.4%) to scientific vocabulary

Keywords

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

Keywords from Contributors

mesh interpretability sequences projection interactive optim hacking network-simulation

Last synced: 6 months ago · JSON representation ·

Repository

Temporal Logic Planning toolbox

Basic Info

Host: GitHub
Owner: tulip-control
License: bsd-3-clause
Language: Python
Default Branch: main
Homepage: http://tulip-control.org
Size: 9.52 MB

Statistics

Stars: 120
Watchers: 15
Forks: 36
Open Issues: 66
Releases: 4

Topics

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

Created over 12 years ago · Last pushed 9 months ago

Metadata Files

Readme Changelog Contributing License Citation Authors

README.rst

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.

Owner

Name: Temporal Logic Planning (TuLiP) toolbox
Login: tulip-control
Kind: organization

Repositories: 7
Profile: https://github.com/tulip-control

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
url: "https://github.com/tulip-control/tulip-control"
preferred-citation:
  type: conference-paper
  title: "Control design for hybrid systems with TuLiP: The Temporal Logic Planning toolbox"
  collection-title: "Proc. of IEEE Conference on Control Applications (CCA)"
  year: 2016
  start: 1030
  end: 1041
  authors:
    - family-names: "Filippidis"
      given-names: "Ioannis"
    - family-names: "Dathathri"
      given-names: "Sumanth"
    - family-names: "Livingston"
      given-names: "Scott C."
    - family-names: "Ozay"
      given-names: "Necmiye"
    - family-names: "Murray"
      given-names: "Richard M."
  doi: 10.1109/CCA.2016.7587949

GitHub Events

Total

Watch event: 8
Issue comment event: 2
Push event: 2
Fork event: 1

Last Year

Watch event: 8
Issue comment event: 2
Push event: 2
Fork event: 1

Committers

Last synced: 9 months ago

All Time

Total Commits: 3,990
Total Committers: 29
Avg Commits per committer: 137.586
Development Distribution Score (DDS): 0.319

Past Year

Commits: 2
Committers: 2
Avg Commits per committer: 1.0
Development Distribution Score (DDS): 0.5

Top Committers

Name	Email	Commits
Ioannis Filippidis	j**s@g**m	2,716
Scott Livingston	s**n@c**u	603
Scott Livingston	s**n@c**u	152
Nok Wongpiromsarn	t**n@g**m	146
Stephanie Tsuei	s**i@g**m	101
Necmiye Ozay	n**y@g**m	99
Richard Murray	m**y@c**u	41
Nick Spooner	n**7@c**k	22
Ufuk Topcu	u**u@g**m	14
Vasu Raman	v**n@c**u	13
Yuchen Lin	y**l@g**m	11
James Bern	j**n@c**u	10
Eric Wolff	e**f@c**u	9
Petter Nilsson	p**i@k**e	8
zexiangliu	z**g@u**u	7
Mumu Xu	m**u@c**u	7
ajwagen	a**n@u**u	5
Jonas Krook	j**k@z**m	4
Stephanie Tsuei	s**i@c**u	4
Clemens Wiltsche	c**5@c**t	3
yilinmo	m**1@g**m	3
Tarek Kabbani	3****b	3
fei sun	f**7@h**m	2
dependabot[bot]	4****]	2
Fei Sun	f**n@c**u	1
Robert Rogersten	r**r@l**e	1
Mihir Sheth	m**s@u**u	1
Mattias Fält	f**s@g**m	1
Yunus Sahin	y**n@u**u	1

Committer Domains (Top 20 + Academic)

caltech.edu: 6 umich.edu: 4 cds.caltech.edu: 2 live.se: 1 cantab.net: 1 zenuity.com: 1 kth.se: 1 cs.cornell.edu: 1 cam.ac.uk: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 69
Total pull requests: 34
Average time to close issues: over 1 year
Average time to close pull requests: 10 months
Total issue authors: 16
Total pull request authors: 11
Average comments per issue: 3.55
Average comments per pull request: 3.94
Merged pull requests: 25
Bot issues: 0
Bot pull requests: 4

Past Year

Issues: 1
Pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: 22 days
Issue authors: 1
Pull request authors: 1
Average comments per issue: 0.0
Average comments per pull request: 0.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

slivingston (23)
johnyf (18)
murrayrm (5)
hashim19 (3)
necozay (3)
abadithela (3)
tichakornw (3)
khassibi (2)
krooken (2)
he-z-r (1)
mhtb32 (1)
Tkabb (1)
ranai-srivastav (1)
matteolucchi (1)
zexiangliu (1)

Pull Request Authors

slivingston (13)
johnyf (7)
murrayrm (3)
Tkabb (3)
dependabot[bot] (3)
tichakornw (3)
krooken (2)
zexiangliu (2)
fyliu1204 (1)
necozay (1)
layashamgah (1)

Top Labels

Issue Labels

enhancement (17) documentation (6) testing (6) bug (5) user question (4) discussion (3) api (1)

Pull Request Labels

enhancement (4) bug (3) dependencies (3) testing (2) documentation (1)

Packages

Total packages: 1
Total downloads:
- pypi 65 last-month

Total dependent packages: 0
Total dependent repositories: 6
Total versions: 5
Total maintainers: 2

pypi.org: tulip

Temporal Logic Planning (TuLiP) Toolbox

Homepage: http://tulip-control.org
Documentation: https://tulip-control.sourceforge.io/doc/
License: BSD
Latest release: 1.4.0
published almost 2 years ago

Versions: 5
Dependent Packages: 0
Dependent Repositories: 6
Downloads: 65 Last month
Docker Downloads: 0

Rankings

Docker downloads count: 4.2%

Dependent repos count: 6.0%

Dependent packages count: 10.0%

Average: 11.1%

Downloads: 24.4%

Maintainers (2)

murrayrm slivingston

Last synced: 6 months ago

Dependencies

requirements.txt pypi

gitpython ==2.1.0
gr1py >=0.2.0
mock *
pip >=9.0.0
setuptools >=39.0.0

setup.py pypi

graphviz *
networkx *
numpy *
omega *
ply *
polytope *
scipy *

.github/workflows/main.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite