Skip to content

Commit c5187db

Browse files
FenglongSongFenglongSong
committed
add docs in html format s.t. can be opened with a local brower
1 parent 8e4d1da commit c5187db

159 files changed

Lines changed: 15757 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.DS_Store‎

6 KB
Binary file not shown.

‎mpt4py_doc_html/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 488d5936424b0709f3d0c6813d37e8e5
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎mpt4py_doc_html/_images/epfl_logo.png‎

16.8 KB
Loading

‎mpt4py_doc_html/_images/nccr_automation_logo.svg‎

Lines changed: 64 additions & 0 deletions
Loading

‎mpt4py_doc_html/_sources/contents.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Contents
2+
=======================
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
:caption: Navigation:
7+
:hidden:
8+
9+
mpt4py.geometry
10+
mpt4py.solvers
11+
mpt4py.systems
12+
mpt4py.controllers

‎mpt4py_doc_html/_sources/index.rst‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
.. mpt4py documentation master file, created by
2+
sphinx-quickstart on Mon Feb 24 22:05:18 2025.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
mpt4py
7+
======
8+
9+
About
10+
------
11+
12+
The **Multi-Parametric Toolbox for Python** (``mpt4py``) is an open-source, Python-based toolbox for
13+
parametric optimization, computational geometry and model predictive control,
14+
covering the core functionalities of the `MPT3 <https://www.mpt3.org>`_ in Matlab.
15+
16+
17+
Credits
18+
-------
19+
20+
The ``mpt4py`` is developed at the `Laboratoire d'Automatique <https://www.epfl.ch/labs/la/>`_ at `École Polytechnique Fédérale de Lausanne (EPFL) <https://www.epfl.ch/>`_, Switzerland. This work was supported by the `Swiss National Science Foundation <https://www.snf.ch/>`_ under the `NCCR Automation <https://nccr-automation.ch/>`_ (grant agreement 51NF40_180545).
21+
22+
The ``mpt4py`` is built upon the following open-source packages:
23+
24+
* `CVXPY <https://www.cvxpy.org>`_: Interface for optimization problems and convex set representation.
25+
* `pycddlib <https://github.com/mcmtroffaes/pycddlib>`_: Used to perform polyhedral operations like vertex/facet enumeration, redundancy elimination, and projection.
26+
* `PyVista <https://docs.pyvista.org>`_: Optional backend for visualization of geometry objects.
27+
* `python-control <https://python-control.readthedocs.io/en/0.10.1/>`_: Used to model dynamical systems.
28+
29+
.. toctree::
30+
:maxdepth: 4
31+
:caption: Navigation:
32+
:hidden:
33+
34+
.. installation.rst
35+
contents.rst
36+
.. tutorials.md
37+
38+
39+
.. raw:: html
40+
41+
<br><br>
42+
43+
.. image:: figures/epfl_logo.png
44+
:width: 150
45+
:alt: EPFL
46+
47+
.. image:: figures/nccr_automation_logo.svg
48+
:width: 200
49+
:alt: NCCR-Automation
50+
51+
52+
FAQ
53+
-------
54+
55+
- What are the differences between `mpt4py` and other polyhedron computation libraries like `pympt` or `pycddlib`?
56+
57+
- `mpt4py` is a high-level library that provides a user-friendly interface for polyhedral computations, while `pympt` and `pycddlib` are lower-level libraries that focus on specific algorithms and data structures. `mpt4py` is built on top of these libraries to provide a more convenient and efficient way to work with polyhedra in Python.

‎mpt4py_doc_html/_sources/installation.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Installation
2+
3+
1. Install [gmp](https://gmplib.org) and [cddlib](https://github.com/cddlib/cddlib):
4+
- For **Ubuntu**:
5+
6+
```
7+
sudo apt-get install libgmp-dev libcdd-dev
8+
```
9+
- For **MacOS**:
10+
11+
```
12+
brew install gmp cddlib
13+
```
14+
2. Install mpt4py in a virtual environment
15+
```bash
16+
# Create a virtual environment
17+
python -m venv venv # to speficy a python version, e.g. 3.12, use python3.12 -m venv venv
18+
source venv/bin/activate # activate the virtual environment
19+
pip install -e .
20+
```

‎mpt4py_doc_html/_sources/mpt4py.controllers.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
The controller package
2+
==========================
3+
4+
Submodules
5+
----------
6+
7+
mpt4py.controllers.base\_controller module
8+
------------------------------------------
9+
10+
.. automodule:: mpt4py.controllers.base_controller
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
mpt4py.controllers.mpc\_controller module
16+
-----------------------------------------
17+
18+
.. automodule:: mpt4py.controllers.mpc_controller
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: mpt4py.controllers
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
:noindex:

‎mpt4py_doc_html/_sources/mpt4py.geometry.rst‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
The geometry package
2+
=======================
3+
4+
convexset
5+
--------------------------------
6+
7+
.. autoclass:: mpt4py.geometry.convexset.ConvexSet
8+
:members:
9+
:special-members:
10+
:show-inheritance:
11+
12+
polyhedron
13+
---------------------------------
14+
15+
.. autoclass:: mpt4py.geometry.polyhedron.Polyhedron
16+
:members:
17+
:special-members: '__eq__', '__add__', '__sub__', '__mul__', '__contains__'
18+
:show-inheritance:
19+
20+
zonotope
21+
-------------------------------
22+
23+
.. autoclass:: mpt4py.geometry.zonotope.Zonotope
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
ellipsoid
29+
-----------------
30+
31+
.. autoclass:: mpt4py.geometry.convexset.Ellipsoid
32+
:members:
33+
:special-members:
34+
:show-inheritance:
35+
36+
.. mpt4py.geometry.convexhull module
37+
.. ---------------------------------
38+
39+
.. .. automodule:: mpt4py.geometry.convexhull
40+
.. :members:
41+
.. :undoc-members:
42+
.. :show-inheritance:
43+
44+
.. cddlib interface
45+
.. -----------------
46+
47+
.. .. automodule:: mpt4py.geometry.interface_cddlib
48+
.. :members:
49+
.. :undoc-members:
50+
.. :show-inheritance:
51+
52+
.. special sets
53+
.. ------------------------------------
54+
55+
.. .. automodule:: mpt4py.geometry.special_sets
56+
.. :members:
57+
.. :undoc-members:
58+
.. :show-inheritance:
59+
60+
61+
.. union of convexsets
62+
.. ------------------------------------
63+
64+
.. .. autoclass:: mpt4py.geometry.union.ConvexSetUnion
65+
.. :members:
66+
.. :special-members:
67+
.. :show-inheritance:
68+
69+
.. union of polyhedra
70+
.. ------------------------------------
71+
72+
.. .. autoclass:: mpt4py.geometry.polyunion.PolyUnion
73+
.. :members:
74+
.. :special-members:
75+
.. :show-inheritance:

‎mpt4py_doc_html/_sources/mpt4py.rst‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
mpt4py package
2+
==============
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
mpt4py.controllers
11+
mpt4py.geometry
12+
mpt4py.solvers
13+
mpt4py.systems
14+
15+
Submodules
16+
----------
17+
18+
mpt4py.base module
19+
------------------
20+
21+
.. automodule:: mpt4py.base
22+
:members:
23+
:undoc-members:
24+
:show-inheritance:
25+
26+
mpt4py.exceptions module
27+
------------------------
28+
29+
.. automodule:: mpt4py.exceptions
30+
:members:
31+
:undoc-members:
32+
:show-inheritance:
33+
34+
mpt4py.tolerances module
35+
------------------------
36+
37+
.. automodule:: mpt4py.tolerances
38+
:members:
39+
:undoc-members:
40+
:show-inheritance:
41+
42+
mpt4py.util module
43+
------------------
44+
45+
.. automodule:: mpt4py.util
46+
:members:
47+
:undoc-members:
48+
:show-inheritance:
49+
50+
Module contents
51+
---------------
52+
53+
.. automodule:: mpt4py
54+
:members:
55+
:undoc-members:
56+
:show-inheritance:

0 commit comments

Comments
 (0)