Metadata-Version: 2.4
Name: symbtools
Version: 0.4.1
Summary: Symbolic calculations related to dynamical systems.
Author-email: Carsten Knoll <firstname.lastname@tu-dresden.de>, Klemens Fritzsche <firstname2.lastname@tu-dresden.de>
License: Copyright (c) 2013-2016 Carsten Knoll, Klemens Fritzsche
        
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
          a. Redistributions of source code must retain the above copyright notice,
             this list of conditions and the following disclaimer.
          b. Redistributions in binary form must reproduce the above copyright
             notice, this list of conditions and the following disclaimer in the
             documentation and/or other materials provided with the distribution.
          c. Neither the name of PyTrajectory nor the names of its contributors
             may be used to endorse or promote products derived from this software
             without specific prior written permission.
        
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
        ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
        LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
        OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
        DAMAGE.
        
Project-URL: Homepage, https://github.com/TUD-RST/symbtools
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sympy!=1.11.*,>=1.7
Requires-Dist: numpy>=1.10.4
Requires-Dist: scipy>=1.0
Requires-Dist: ipydex>=0.8.2
Requires-Dist: pytest
Requires-Dist: matplotlib
Provides-Extra: mpc
Requires-Dist: casadi; extra == "mpc"
Provides-Extra: visualization
Requires-Dist: matplotlib>=3.1; extra == "visualization"
Requires-Dist: ipywidgets>=7.5; extra == "visualization"
Dynamic: license-file



[![PyPI Package Link](https://badge.fury.io/py/symbtools.svg "PyPI Package Link")](https://badge.fury.io/py/symbtools)
[![Build Status](https://cloud.drone.io/api/badges/TUD-RST/symbtools/status.svg?ref=refs/heads/main)](https://cloud.drone.io/TUD-RST/symbtools) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.275073.svg)](https://doi.org/10.5281/zenodo.275073)
<!-- currently travis does not work -->
<!-- [![Travis CI Unit Test Result badge](https://travis-ci.org/TUD-RST/symbtools.svg?branch=master "Travis CI Unit Test Result badge")](https://travis-ci.org/TUD-RST/symbtools) --> 


(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](https://nbviewer.jupyter.org/github/TUD-RST/symbtools/tree/main/docs/demo_notebooks/),
auf die [Unit-Tests](https://github.com/TUD-RST/symbtools/blob/main/symbtools/test/test_modeltools.py)
und auf die Docstrings im Quellcode verwiesen.
Für Fragen und Anregungen stehen die Github-Issue-Funktion sowie der [Paketbereuer](https://tu-dresden.de/ing/elektrotechnik/rst/das-institut/beschaeftigte/carsten-knoll)
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](https://nbviewer.jupyter.org/github/TUD-RST/symbtools/tree/main/docs/demo_notebooks/),
to the [unit tests](https://github.com/TUD-RST/symbtools/blob/main/symbtools/test/test_modeltools.py)
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](https://tu-dresden.de/ing/elektrotechnik/rst/das-institut/beschaeftigte/carsten-knoll).

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

