Metadata-Version: 2.1
Name: pendsim
Version: 1.0.4
Summary: A pendulum simulator
Home-page: https://github.com/rland93/pendsim
Author: Mike Sutherland
Author-email: msutherl@uci.edu
License: MIT
Project-URL: Bug Tracker, https://github.com/rland93/pendsim/issues
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
License-File: LICENSE


# pendsim: an Inverted Pendulum-On-A-Cart Sandbox!

A simple inverse-pendulum simulator, with a module to render animations of the simulation and API for custom controllers. See the [Example Video](https://user-images.githubusercontent.com/33564709/116198178-817dde80-a6ea-11eb-8cdf-e0c53c922416.mp4).

It uses rk45 to simulate a dynamic model of the simple inverse pendulum on a cart: [Inverted Pendulum](https://en.wikipedia.org/wiki/Inverted_pendulum).

For more details on the package features, as well as how it can be used in an educational context, see the pending JOSE submission: ([Markdown](https://github.com/rland93/pendsim/paper.pdf)), ([PDF](https://github.com/rland93/pendsim/paper.pdf))

## Installation
This package is published on PyPi. Install with `pip`:

```bash
pip install pendsim
```

Requires Python 3.

## Documentation

[The Full Package Documentation is available here.](http://rland93.github.io/pendsim/)

