{"author":"","author_email":"Nico Schlömer ","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Framework :: Matplotlib","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Multimedia :: Graphics :: Graphics Conversion","Topic :: Scientific/Engineering :: Visualization"],"description":"

\n $\"tikzplotlib\"$ \n

The artist formerly known as matplotlib2tikz.

\n\n[![PyPi Version](https://img.shields.io/pypi/v/tikzplotlib.svg?style=flat-square)](https://pypi.org/project/tikzplotlib)\n[![Packaging status](https://repology.org/badge/tiny-repos/python:tikzplotlib.svg)](https://repology.org/project/python:tikzplotlib/versions)\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/tikzplotlib.svg?style=flat-square)](https://pypi.org/pypi/tikzplotlib/)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1173089.svg?style=flat-square)](https://doi.org/10.5281/zenodo.1173089)\n[![GitHub stars](https://img.shields.io/github/stars/nschloe/tikzplotlib.svg?style=flat-square&logo=github&label=Stars&logoColor=white)](https://github.com/nschloe/tikzplotlib)\n[![Downloads](https://pepy.tech/badge/tikzplotlib/month?style=flat-square)](https://pepy.tech/project/tikzplotlib)\n\n\n\n[![Documentation Status](https://readthedocs.org/projects/tikzplotlib/badge/?version=latest&style=flat-square)](https://readthedocs.org/projects/tikzplotlib/?badge=latest)\n[![awesome](https://img.shields.io/badge/awesome-yes-brightgreen.svg?style=flat-square)](https://github.com/nschloe/tikzplotlib)\n\n[![gh-actions](https://img.shields.io/github/workflow/status/nschloe/tikzplotlib/ci?style=flat-square)](https://github.com/nschloe/tikzplotlib/actions?query=workflow%3Aci)\n[![codecov](https://img.shields.io/codecov/c/github/nschloe/tikzplotlib.svg?style=flat-square)](https://codecov.io/gh/nschloe/tikzplotlib)\n[![LGTM](https://img.shields.io/lgtm/grade/python/github/nschloe/tikzplotlib.svg?style=flat-square)](https://lgtm.com/projects/g/nschloe/tikzplotlib)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)\n\nThis is tikzplotlib, a Python tool for converting matplotlib figures into\n[PGFPlots](https://www.ctan.org/pkg/pgfplots) ([PGF/TikZ](https://www.ctan.org/pkg/pgf))\nfigures like\n\n![](https://nschloe.github.io/tikzplotlib/example.png)\n\nfor native inclusion into LaTeX or ConTeXt documents.\n\nThe output of tikzplotlib is in [PGFPlots](https://github.com/pgf-tikz/pgfplots/), a TeX\nlibrary that sits on top of [PGF/TikZ](https://en.wikipedia.org/wiki/PGF/TikZ) and\ndescribes graphs in terms of axes, data etc. Consequently, the output of tikzplotlib\n\n- retains more information,\n- can be more easily understood, and\n- is more easily editable\n\nthan [raw TikZ output](https://matplotlib.org/users/whats_new.html#pgf-tikz-backend).\nFor example, the matplotlib figure\n\n```python\nimport matplotlib.pyplot as plt\nimport numpy as np\n\nplt.style.use(\"ggplot\")\n\nt = np.arange(0.0, 2.0, 0.1)\ns = np.sin(2 * np.pi * t)\ns2 = np.cos(2 * np.pi * t)\nplt.plot(t, s, \"o-\", lw=4.1)\nplt.plot(t, s2, \"o-\", lw=4.1)\nplt.xlabel(\"time (s)\")\nplt.ylabel(\"Voltage (mV)\")\nplt.title(\"Simple plot $\\\\frac{\\\\alpha}{2}$\")\nplt.grid(True)\n\nimport tikzplotlib\n\ntikzplotlib.save(\"test.tex\")\n```\n\n\n\n```python\nimport matplotlib as mpl\n\nplt.close()\nmpl.rcParams.update(mpl.rcParamsDefault)\n```\n\n-->\n(see above) gives\n\n```latex\n\\begin{tikzpicture}\n\n\\definecolor{color0}{rgb}{0.886274509803922,0.290196078431373,0.2}\n\\definecolor{color1}{rgb}{0.203921568627451,0.541176470588235,0.741176470588235}\n\n\\begin{axis}[\naxis background/.style={fill=white!89.8039215686275!black},\naxis line style={white},\ntick align=outside,\ntick pos=left,\ntitle={Simple plot \$\\displaystyle \\frac{\\alpha}{2}\$},\nx grid style={white},\nxlabel={time (s)},\nxmajorgrids,\nxmin=-0.095, xmax=1.995,\nxtick style={color=white!33.3333333333333!black},\ny grid style={white},\nylabel={Voltage (mV)},\nymajorgrids,\nymin=-1.1, ymax=1.1,\nytick style={color=white!33.3333333333333!black}\n]\n\\addplot [line width=1.64pt, color0, mark=*, mark size=3, mark options={solid}]\ntable {%\n0 0\n0.1 0.587785252292473\n% [...]\n1.9 -0.587785252292473\n};\n\\addplot [line width=1.64pt, color1, mark=*, mark size=3, mark options={solid}]\ntable {%\n0 1\n0.1 0.809016994374947\n% [...]\n1.9 0.809016994374947\n};\n\\end{axis}\n\n\\end{tikzpicture}\n```\n\n(Use `get_tikz_code()` instead of `save()` if you want the code as a string.)\n\nTweaking the plot is straightforward and can be done as part of your TeX work flow.\n[The fantastic PGFPlots manual](http://pgfplots.sourceforge.net/pgfplots.pdf) contains\ngreat examples of how to make your plot look even better.\n\nOf course, not all figures produced by matplotlib can be converted without error.\nNotably, [3D plots don't work](https://github.com/matplotlib/matplotlib/issues/7243).\n\n### Installation\n\ntikzplotlib is [available from the Python Package\nIndex](https://pypi.org/project/tikzplotlib/), so simply do\n\n```\npip install tikzplotlib\n```\n\nto install.\n\n### Usage\n\n1. Generate your matplotlib plot as usual.\n\n2. Instead of `pyplot.show()`, invoke tikzplotlib by\n\n ```python\n import tikzplotlib\n\n tikzplotlib.save(\"mytikz.tex\")\n # or\n tikzplotlib.save(\"mytikz.tex\", flavor=\"context\")\n ```\n\n to store the TikZ file as `mytikz.tex`.\n\n3. Add the contents of `mytikz.tex` into your TeX source code. A convenient way of doing\n so is via\n\n ```latex\n \\input{/path/to/mytikz.tex}\n ```\n\n Also make sure that the packages for PGFPlots and proper Unicode support and are\n included in the header of your document:\n\n ```latex\n \\usepackage[utf8]{inputenc}\n \\usepackage{pgfplots}\n \\DeclareUnicodeCharacter{2212}{−}\n \\usepgfplotslibrary{groupplots,dateplot}\n \\usetikzlibrary{patterns,shapes.arrows}\n \\pgfplotsset{compat=newest}\n ```\n\n or:\n\n ```latex\n \\setupcolors[state=start]\n \\usemodule[tikz]\n \\usemodule[pgfplots]\n \\usepgfplotslibrary[groupplots,dateplot]\n \\usetikzlibrary[patterns,shapes.arrows]\n \\pgfplotsset{compat=newest}\n \\unexpanded\\def\\startgroupplot{\\groupplot}\n \\unexpanded\\def\\stopgroupplot{\\endgroupplot}\n ```\n\n You can also get the code via:\n\n ```python\n import tikzplotlib\n\n tikzplotlib.Flavors.latex.preamble()\n # or\n tikzplotlib.Flavors.context.preamble()\n ```\n\n4. [Optional] Clean up the figure before exporting to tikz using the `clean_figure`\n command.\n\n ```python\n import matplotlib.pyplot as plt\n import numpy as np\n\n # ... do your plotting\n\n import tikzplotlib\n\n tikzplotlib.clean_figure()\n tikzplotlib.save(\"test.tex\")\n ```\n\n The command will remove points that are outside the axes limits, simplify curves and\n reduce point density for the specified target resolution.\n\n The feature originated from the\n [matlab2tikz](https://github.com/matlab2tikz/matlab2tikz) project and is adapted to\n matplotlib.\n\n### Contributing\n\nIf you experience bugs, would like to contribute, have nice examples of what tikzplotlib\ncan do, or if you are just looking for more information, then please visit\n[tikzplotlib's GitHub page](https://github.com/nschloe/tikzplotlib).\n\n### Testing\n\ntikzplotlib has automatic unit testing to make sure that the software doesn't\naccidentally get worse over time. In `test/`, a number of test cases are specified.\nThose run through tikzplotlib and compare the output with a previously stored reference\nTeX file.\n\nTo run the tests, just check out this repository and type\n\n```\npytest\n```\n\n### License\n\ntikzplotlib is published under the [MIT\nlicense](https://en.wikipedia.org/wiki/MIT_License).\n","description_content_type":"text/markdown","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"","keywords":"latex,tikz,matplotlib,graphics","license":"","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"tikzplotlib","package_url":"https://pypi.org/project/tikzplotlib/","platform":"","project_url":"https://pypi.org/project/tikzplotlib/","project_urls":{"Code":"https://github.com/nschloe/tikzplotlib","Funding":"https://github.com/sponsors/nschloe","Issues":"https://github.com/nschloe/tikzplotlib/issues"},"provides_extra":null,"release_url":"https://pypi.org/project/tikzplotlib/0.10.1/","requires_dist":["matplotlib >= 1.4.0","numpy","Pillow","webcolors"],"requires_python":">=3.7","summary":"Convert matplotlib figures into TikZ/PGFPlots","version":"0.10.1","yanked":false,"yanked_reason":null}

Dependencies of tikzplotlib (4).
Dependency	Optional
matplotlib	false
numpy	false
Pillow	false
webcolors	false

Package search

tikzplotlib

project_urls

Dependencies

All package metadata

Releases