Metadata-Version: 2.1
Name: polytope
Version: 0.2.4
Summary: Polytope Toolbox
Home-page: https://tulip-control.org
Author: Caltech Control and Dynamical Systems
Author-email: polytope@tulip-control.org
License: BSD
Project-URL: Bug Tracker, https://github.com/tulip-control/polytope/issues
Project-URL: Documentation, https://tulip-control.github.io/polytope/
Project-URL: Source Code, https://github.com/tulip-control/polytope
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Python: >=3.8
License-File: LICENSE
License-File: AUTHORS

Polytope
========

This is the source repository for ``polytope``, a toolbox for geometric
operations on polytopes in any dimension.  Documentation is available in
the directory ``doc/`` and also at https://tulip-control.github.io/polytope/
The directory ``examples/`` contains examples.


Installation
------------

From `PyPI <https://pypi.org/project/polytope/>`_::

  pip install polytope

From source::

  pip install .


Dependencies
------------
Required: ``numpy``, ``scipy``, ``networkx``.
Optionally, if ``cvxopt`` is installed and
linked to `GLPK <https://en.wikipedia.org/wiki/GNU_Linear_Programming_Kit>`_,
then ``polytope`` will prefer GLPK,
because it is faster than ``scipy``.
For more details, see ``requirements.txt``.


Contact and support
-------------------

* Ask for help on the `tulip-control-users mailing list
  <https://sourceforge.net/p/tulip-control/mailman/tulip-control-users>`_
* For release announcements, join the `tulip-control-announce mailing list
  <https://sourceforge.net/p/tulip-control/mailman/tulip-control-announce>`_
* Bug reports and feature requests should be made at
  https://github.com/tulip-control/polytope/issues
  Please check for prior discussion and reports before opening a new issue.


License
-------
Polytope is licensed under the 3-clause BSD license.  The full statement is
provided in the file named `LICENSE`.


Acknowledgment
--------------
Polytope was part of the `Temporal Logic Planning Toolbox (TuLiP)
<https://tulip-control.org>`_ before growing to become an independent package.
It originates from changesets 7bb73a9f725572db454a0a5e4957da84bc778f65 and
3178c570ee1ef06eb8ace033f205f51743ac54c6 of `TuLiP
<https://github.com/tulip-control/tulip-control>`_.
