Metadata-Version: 2.4
Name: dqrobotics-pyplot
Version: 25.4.0.58
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/x-rst
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: dqrobotics
Dynamic: license-file

Quickstart
==========

These are the non-official `pyplot` extensions to `dqrobotics`.

Gallery
-------

`https://marinholab.github.io/dqrobotics-pyplot/gallery.html <https://marinholab.github.io/dqrobotics-pyplot/gallery.html>`_

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
------------

.. code-block:: console

    python3 -m pip install dqrobotics-pyplot


Import
------

.. code-block:: 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

Basic examples
--------------

Figures
+++++++

See the script

.. code-block:: console

    src/dqrobotics_extensions/pyplot/example.py


or alternatively the installed version

.. code-block:: console

    dqrobotics_pyplot_example

Animations
++++++++++

See the script

.. code-block:: console

    src/dqrobotics_extensions/pyplot/example_animations.py

or alternatively the installed version

.. code-block:: console

    dqrobotics_pyplot_example_animation
