https://github.com/kitware/trame-matplotlib
Trame widget for Matplotlib
https://github.com/kitware/trame-matplotlib
trame trame-maintenance-program
Last synced: about 1 year ago
JSON representation
Trame widget for Matplotlib
- Host: GitHub
- URL: https://github.com/kitware/trame-matplotlib
- Owner: Kitware
- License: bsd-3-clause
- Created: 2022-05-10T23:12:15.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-09T21:00:45.000Z (over 1 year ago)
- Last Synced: 2025-04-11T15:47:38.180Z (about 1 year ago)
- Topics: trame, trame-maintenance-program
- Language: Python
- Homepage:
- Size: 251 KB
- Stars: 5
- Watchers: 8
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
.. |pypi_download| image:: https://img.shields.io/pypi/dm/trame-matplotlib
Matplotlib widget for trame |pypi_download|
===========================================================================
.. image:: https://github.com/Kitware/trame-matplotlib/actions/workflows/test_and_release.yml/badge.svg
:target: https://github.com/Kitware/trame-matplotlib/actions/workflows/test_and_release.yml
:alt: Test and Release
trame-matplotlib extend trame **widgets** with a component that is capable of rendering Matplotlib plots.
This library allow you to create rich visualization by leveraging `Matplotlib `__ within trame.
Installing
-----------------------------------------------------------
trame-matplotlib can be installed with `pip `__:
.. code-block:: bash
pip install --upgrade trame-matplotlib
Usage
-----------------------------------------------------------
The `Trame Tutorial `__ is the place to go to learn how to use the library and start building your own application.
The `API Reference `__ documentation provides API-level documentation.
License
-----------------------------------------------------------
trame-matplotlib is made available under the BSD-3 License. For more details, see `LICENSE `__
This package is under the BSD-3 License as it is compatible with `matplotlib `__ and `mpld3 `__ which are used underneath that trame widget.
Community
-----------------------------------------------------------
`Trame `__ | `Discussions `__ | `Issues `__ | `RoadMap `__ | `Contact Us `__
.. image:: https://zenodo.org/badge/410108340.svg
:target: https://zenodo.org/badge/latestdoi/410108340
Enjoying trame?
-----------------------------------------------------------
Share your experience `with a testimonial `__ or `with a brand approval `__.
Code sample
-----------------------------------------------------------
Using the component method
.. code-block:: python
import matplotlib.pyplot as plt
from trame.widgets import matplotlib
fig, ax = plt.subplots(**figure_size)
widget = matplotlib.Figure(figure=None) # could pass fig at construction
widget.update(fig)
JavaScript dependency
-----------------------------------------------------------
This Python package bundle the ``mpld3@0.5.7`` JavaScript library. If you would like us to upgrade it, `please reach out `_.