Metadata-Version: 2.4
Name: dqrobotics-pyplot
Version: 25.4.0.22
Summary: An extension of dqrobotics to use matplotlib.pyplot to plot DQ elements.
Author-email: "Murilo M. Marinho" <murilomarinho@ieee.org>
Maintainer-email: "Murilo M. Marinho" <murilomarinho@ieee.org>
Project-URL: Homepage, https://github.com/MarinhoLab/dqrobotics-pyplot
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: dqrobotics
Dynamic: license-file

# Quickstart: `pyplot` extensions to `dqrobotics`

## Issues

[https://github.com/MarinhoLab/dqrobotics-pyplot/issues](https://github.com/MarinhoLab/dqrobotics-pyplot/issues)

## Documentation

[https://marinholab.github.io/dqrobotics-pyplot/](https://marinholab.github.io/dqrobotics-pyplot/)

## Installation

```Console
python3 -m pip install dqrobotics-pyplot
```

## Import

```python
from dqrobotics import *
from matplotlib import pyplot as plt
# Adding the prefix `dqp` to help users differentiate from `plt`
import dqrobotics_extensions.pyplot as dqp
```

## Usage examples

### Basic functionalities

See the script in

```Console
src/dqrobotics_extensions/pyplot/example.py
```

or alternatively the installed version

```Console
dqrobotics_pyplot_example
```

### Animations

See

```Console
src/dqrobotics_extensions/pyplot/example_animations.py
```

or alternatively the installed version

```Console
dqrobotics_pyplot_example_animation
```
