Convert matplotlib figures into TikZ/PGFPlots
Project description
The artist formerly known as matplotlib2tikz.
This is tikzplotlib, a Python tool for converting matplotlib figures into PGFPlots (PGF/TikZ) figures like
for native inclusion into LaTeX or ConTeXt documents.
The output of tikzplotlib is in PGFPlots, a TeX library that sits on top of PGF/TikZ and describes graphs in terms of axes, data etc. Consequently, the output of tikzplotlib
- retains more information,
- can be more easily understood, and
- is more easily editable
than raw TikZ output. For example, the matplotlib figure
import matplotlib.pyplot as plt
import numpy as np
plt.style.use("ggplot")
t = np.arange(0.0, 2.0, 0.1)
s = np.sin(2 * np.pi * t)
s2 = np.cos(2 * np.pi * t)
plt.plot(t, s, "o-", lw=4.1)
plt.plot(t, s2, "o-", lw=4.1)
plt.xlabel("time (s)")
plt.ylabel("Voltage (mV)")
plt.title("Simple plot $\\frac{\\alpha}{2}$")
plt.grid(True)
import tikzplotlib
tikzplotlib.save("test.tex")
import matplotlib as mpl
plt.close()
mpl.rcParams.update(mpl.rcParamsDefault)
--> (see above) gives
\begin{tikzpicture}
\definecolor{color0}{rgb}{0.886274509803922,0.290196078431373,0.2}
\definecolor{color1}{rgb}{0.203921568627451,0.541176470588235,0.741176470588235}
\begin{axis}[
axis background/.style={fill=white!89.8039215686275!black},
axis line style={white},
tick align=outside,
tick pos=left,
title={Simple plot \(\displaystyle \frac{\alpha}{2}\)},
x grid style={white},
xlabel={time (s)},
xmajorgrids,
xmin=-0.095, xmax=1.995,
xtick style={color=white!33.3333333333333!black},
y grid style={white},
ylabel={Voltage (mV)},
ymajorgrids,
ymin=-1.1, ymax=1.1,
ytick style={color=white!33.3333333333333!black}
]
\addplot [line width=1.64pt, color0, mark=*, mark size=3, mark options={solid}]
table {%
0 0
0.1 0.587785252292473
% [...]
1.9 -0.587785252292473
};
\addplot [line width=1.64pt, color1, mark=*, mark size=3, mark options={solid}]
table {%
0 1
0.1 0.809016994374947
% [...]
1.9 0.809016994374947
};
\end{axis}
\end{tikzpicture}
(Use get_tikz_code()
instead of save()
if you want the code as a string.)
Tweaking the plot is straightforward and can be done as part of your TeX work flow. The fantastic PGFPlots manual contains great examples of how to make your plot look even better.
Of course, not all figures produced by matplotlib can be converted without error. Notably, 3D plots don't work.
Installation
tikzplotlib is available from the Python Package Index, so simply do
pip install tikzplotlib
to install.
Usage
-
Generate your matplotlib plot as usual.
-
Instead of
pyplot.show()
, invoke tikzplotlib byimport tikzplotlib tikzplotlib.save("mytikz.tex") # or tikzplotlib.save("mytikz.tex", flavor="context")
to store the TikZ file as
mytikz.tex
. -
Add the contents of
mytikz.tex
into your TeX source code. A convenient way of doing so is via\input{/path/to/mytikz.tex}
Also make sure that the packages for PGFPlots and proper Unicode support and are included in the header of your document:
\usepackage[utf8]{inputenc} \usepackage{pgfplots} \DeclareUnicodeCharacter{2212}{−} \usepgfplotslibrary{groupplots,dateplot} \usetikzlibrary{patterns,shapes.arrows} \pgfplotsset{compat=newest}
or:
\setupcolors[state=start] \usemodule[tikz] \usemodule[pgfplots] \usepgfplotslibrary[groupplots,dateplot] \usetikzlibrary[patterns,shapes.arrows] \pgfplotsset{compat=newest} \unexpanded\def\startgroupplot{\groupplot} \unexpanded\def\stopgroupplot{\endgroupplot}
You can also get the code via:
import tikzplotlib tikzplotlib.Flavors.latex.preamble() # or tikzplotlib.Flavors.context.preamble()
-
[Optional] Clean up the figure before exporting to tikz using the
clean_figure
command.import matplotlib.pyplot as plt import numpy as np # ... do your plotting import tikzplotlib tikzplotlib.clean_figure() tikzplotlib.save("test.tex")
The command will remove points that are outside the axes limits, simplify curves and reduce point density for the specified target resolution.
The feature originated from the matlab2tikz project and is adapted to matplotlib.
Contributing
If you experience bugs, would like to contribute, have nice examples of what tikzplotlib can do, or if you are just looking for more information, then please visit tikzplotlib's GitHub page.
Testing
tikzplotlib has automatic unit testing to make sure that the software doesn't
accidentally get worse over time. In test/
, a number of test cases are specified.
Those run through tikzplotlib and compare the output with a previously stored reference
TeX file.
To run the tests, just check out this repository and type
pytest
License
tikzplotlib is published under the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file tikzplotlib-0.10.1.tar.gz
.
File metadata
- Download URL: tikzplotlib-0.10.1.tar.gz
- Upload date:
- Size: 104.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.27.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93d141342d143804fc1dfabe03e6d4e38e547cf72803bdf124615affdd56f59d |
|
MD5 | 2bc4eee1ff3477df513466376ac2e392 |
|
BLAKE2b-256 | 98223ed358885b75c222f39221d0cc2793f4059c02788b669363a0e7df03241f |
File details
Details for the file tikzplotlib-0.10.1-py3-none-any.whl
.
File metadata
- Download URL: tikzplotlib-0.10.1-py3-none-any.whl
- Upload date:
- Size: 54.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.27.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf0451b86fe4db40aa742f7e5a180dfaaadf57c746ddb2ab7e58a5163d8be75f |
|
MD5 | e745f0a5fedc468e34f05ea04071b4b8 |
|
BLAKE2b-256 | 673e24d1c41cbe520d17cfb887e1d527937ad3b6a1c3dc42c12cd48fa60d2dc7 |