Welcome to

What is pydykit?

pydykit is a Python-based dynamics simulation toolkit for dynamical systems. The package is based on time stepping methods, which are discrete versions of the corresponding dynamics equations - either ordinary differential equations (ODEs) or differential-algebraic equations (DAEs).

How to install?

Directly install from the Python Package Index (PyPI) with

pip install pydykit

or clone the repository and install the package locally, following these steps:

1. Create a new virtual environment and activate it. We recommend using venv:

   python3.12 -m venv .venv
   source .venv/bin/activate
   

2. Clone the repository
3. Install in editable- / development-mode:

   pip install --editable .
   

4. Run your first script, e.g.

   python scripts/s*.py
   

How to use?

Check out the getting started to familiarize yourself with pydykit and examples for more details.

Who are we?

• Julian K. Bauer - Code architect - @JulianKarlBauer
• Philipp L. Kinon - Core developer - @plkinon