(English version below)

Allgemeines

Das Paket symbtools enthält eine Sammlung von Funktionen für symbolischen Rechnungen, die bei der Untersuchung nichtlineare dynamischer Systeme im Rahmen der Regelungs- und Steuerungstheorie auftreten.

Speziell ist im Modul modeltools Funktionalität gebündelt, die zur Herleitung, Analyse und Numerischen Lösung (Simulation) von Bewegungsgleichungen mechanischer Systeme mit und ohne algebraische Nebenbedingungen mit Hilfe der Lagrange-Gleichungen 1. bzw. 2. Art dient.

Eine klassische Dokumentation des Paketes ist in Vorbereitung. Vorerst wird auf die, die Demo-Notebooks, auf die Unit-Tests und auf die Docstrings im Quellcode verwiesen. Für Fragen und Anregungen stehen die Github-Issue-Funktion sowie der Paketbereuer per Mail zur Verfügung.

Der Programmcode hat insgesamt den Status von "Forschungscode", d.h. das Paket befindet sich nach wie vor in Entwicklung. Obwohl wesentliche Teile durch Unit-Tests abgedeckt sind, enthält der Code mit einer gewissen Wahrscheinlichkeit Fehler.

General Information

The package symbtools contains collection of functions for symbolic calculations, which occur along with the investigation of nonlinear dynamical systems in the field of control theory.

Especially the module modeltools contains functionality wich serves for generating, analizing and simulating the equations of motion of mechanical systems based on the Lagrange-Equations of 1st and 2nd kind.

Classical docs for this package are still in preparation. Meanwhile we refer to the Demo Notebooks, to the unit tests and finally to the docstrings im in the sources. If you have any question feel, free to open an issue or to email the maintainer.

Note that the package is in development state. Despite that a substantial part is covered by unit test, the code will contain bugs with some probability.

Installation

Make sure you have the following dependencies installed (see also requirements.txt):

sympy
numpy
scipy
ipython
ipydex
matplotlib (for visualization)

Get symbtools using PyPI::

$ pip install symbtools

or the latest git version::

$ git clone https://github.com/TUD-RST/symbtools.git