matrach / matplotlib-terminal

Matplotlib backend to plot in terminal using matrach/img2unicode

matplotlib-terminal

Matplotlib backend to plot in terminal using matrach/img2unicode

This is in proof of concept stage, so stay tuned! The library is optimized for Gnome Terminal with Ubuntu Mono font. Nevertheless 'block' and 'braille' renderers should work with most modern terminals.

Install it with:

$ pip install matplotlib-terminal

To speed ~10x up the braille and gamma renderers, install an optional dependency of img2unicode:

$ pip install 'img2unicode[n2]'

Alternatives, which operate on raster output

• https://github.com/jktr/matplotlib-backend-notcurses
• https://github.com/jktr/matplotlib-backend-kitty

Usage:

import matplotlib_terminal
import matplotlib.pyplot as plt
# Or in short:
# from matplotlib_terminal import plt


plt.plot([0, 1], [0, 1])
plt.plot([1, 0], [0, 1], lw=3)
plt.scatter([0], [.5])

plt.show()
plt.show('gamma') # Use RendererGamma-fast/noblock from img2unicode renderer
plt.show('block') # Use Renderer-fast/block from img2unicode, dual color!
plt.show('braille') # Use RendererGamma-fast/braille from img2unicode renderer
plt.close()

Sample results

Gamma renderer: Block renderer: Braille renderer:

TODO

• figure out how to configure the lib in matplotlib-ish way (eg. rcParams)
• allow to specify figure size in terms of cells
• compare with alternatives
• auto select backend from alternatives

matplotlib-terminal's Issues

Can't install on windows

pip install isn't working, and I tried manually installing as well. Am I missing something?

PS super dope project!!

Support sixel (and other native image displaying protocols)

This repo is getting more attention that I initially anticipated. Since people actually use the tool, it would be nice to support native image rendering in some terminals (most notably through sixel).
Reference of modern terminals capabilities: https://github.com/dankamongmen/notcurses/blob/master/TERMINALS.md

Ref:
https://github.com/saitoha/libsixel
Pure Python: https://pypi.org/project/PySixel/
https://github.com/dankamongmen/notcurses

How to make it work on a ubuntu server?

I installed it on ubuntu server 20.04. If i connect to it by ssh on a gnome-terminal, this package works fine. Otherwise if i am directly using the server the special caracters dont appear and the result is not good. Do you have any tip to solve it?