Metadata-Version: 2.0
Name: matplotlib2tikz
Version: 0.6.6
Summary: convert matplotlib figures into TikZ/PGFPlots
Home-page: https://github.com/nschloe/matplotlib2tikz
Author: Nico Schlömer
Author-email: nico.schloemer@gmail.com
License: License :: OSI Approved :: MIT License
Download-URL: https://pypi.python.org/pypi/matplotlib2tikz
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Dist: Pillow (>=3.0.0)
Requires-Dist: matplotlib (>=1.4.0)
Requires-Dist: numpy
Requires-Dist: pipdated

matplotlib2tikz
===============

|Build Status| |Code Health| |codecov| |Documentation Status| |PyPi
Version| |GitHub stars|

This is matplotlib2tikz, a Python tool for converting matplotlib figures
into `PGFPlots <https://www.ctan.org/pkg/pgfplots>`__
(`TikZ <https://www.ctan.org/pkg/pgf>`__) figures like

.. figure:: https://nschloe.github.io/matplotlib2tikz/latex3.png
   :alt: 

for native inclusion into LaTeX documents.

The output of matplotlib2tikz is in
`PGFPlots <http://pgfplots.sourceforge.net/pgfplots.pdf>`__, a LaTeX
library that sits on top of TikZ and describes graphs in terms of axes,
data etc. Consequently, the output of matplotlib2tikz retains more
information, can be more easily understood, and is more easily editable
than `raw TikZ
output <http://matplotlib.org/users/whats_new.html#pgf-tikz-backend>`__.
For example, the matplotlib figure

.. code:: python

    from matplotlib import pyplot as plt
    from matplotlib import style
    import numpy as np
    fig = plt.figure()
    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)

    from matplotlib2tikz import save as tikz_save
    tikz_save('test.tex')

(see above) gives

.. code:: latex

    % This file was created by matplotlib2tikz vx.y.z.
    \begin{tikzpicture}

    \definecolor{color1}{rgb}{0.203921568627451,0.541176470588235,0.741176470588235}
    \definecolor{color0}{rgb}{0.886274509803922,0.290196078431373,0.2}

    \begin{axis}[
    title={Simple plot $\frac{\alpha}{2}$},
    xlabel={time(s)},
    ylabel={Voltage (mV)},
    xmin=0, xmax=2,
    ymin=-1, ymax=1,
    tick align=outside,
    xmajorgrids,
    x grid style={white},
    ymajorgrids,
    y grid style={white},
    axis line style={white},
    axis background/.style={fill=white!89.803921568627459!black}
    ]
    \addplot [line width=1.64pt, color0, mark=*, mark size=3, mark options={solid,draw=black}]
    table {%
    0 0
    0.1 0.587785252292473
    % [...]
    1.9 -0.587785252292473
    };
    \addplot [line width=1.64pt, color1, mark=*, mark size=3, mark options={solid,draw=black}]
    table {%
    0 1
    0.1 0.809016994374947
    % [...]
    1.9 0.809016994374947
    };
    \end{axis}

    \end{tikzpicture}

Tweaking the plot is straightforward and can be done as part of your
LaTeX work flow. `The fantastic PGFPlots
manual <http://pgfplots.sourceforge.net/pgfplots.pdf>`__ contains great
examples of how to make your plot look even better.

Installation
~~~~~~~~~~~~

matplotlib2tikz is `available from the Python Package
Index <https://pypi.python.org/pypi/matplotlib2tikz/>`__, so simply type

::

    pip install -U matplotlib2tikz

to install/update.

Dependencies
^^^^^^^^^^^^

matplotlib2tikz needs `matplotlib <http://matplotlib.org/>`__ and
`NumPy <http://www.numpy.org/>`__ to work. matplotlib2tikz works both
with Python 2 and Python 3.

To use the resulting TikZ/PGFPlots figures, your LaTeX installation
needs

-  TikZ (aka PGF, >=2.00), and
-  PGFPlots (>=1.3).

Usage
~~~~~

1. Generate your matplotlib plot as usual.

2. Instead of ``pyplot.show()``, invoke matplotlib2tikz by

   .. code:: python

       tikz_save('mytikz.tex');

   to store the TikZ file as ``mytikz.tex``. Load the library with:

   .. code:: python

       from matplotlib2tikz import save as tikz_save

   *Optional:* The scripts accepts several options, for example
   ``height``, ``width``, ``encoding``, and some others. Invoke by

   .. code:: python

       tikz_save('mytikz.tex', figureheight='4cm', figurewidth='6cm')

   Note that height and width must be set large enough; setting it too
   low may result in a LaTeX compilation failure along the lines of
   ``Dimension Too Large`` or ``Arithmetic Overflow``; see information
   about these errors in `the PGFPlots
   manual <http://pgfplots.sourceforge.net/pgfplots.pdf>`__. To specify
   the dimension of the plot from within the LaTeX document, try

   .. code:: python

       tikz_save(
           'mytikz.tex',
           figureheight = '\\figureheight',
           figurewidth = '\\figurewidth'
           )

   and in the LaTeX source

   .. code:: latex

       \newlength\figureheight
       \newlength\figurewidth
       \setlength\figureheight{4cm}
       \setlength\figurewidth{6cm}
       \input{mytikz.tex}

3. Add the contents of ``mytikz.tex`` into your LaTeX source code; a
   convenient way of doing so is via ``\input{/path/to/mytikz.tex}``.
   Also make sure that in the header of your document the packages for
   PGFPlots and proper Unicode support and are included:

   .. code:: latex

       \usepackage[utf8]{inputenc}
       \usepackage{pgfplots}

   Additionally, with LuaLaTeX

   .. code:: latex

       \usepackage{fontspec}

   is needed to typeset Unicode characters. Optionally, to use the
   latest PGFPlots features, insert

   .. code:: latex

       \pgfplotsset{compat=newest}

Contributing
~~~~~~~~~~~~

If you experience bugs, would like to contribute, have nice examples of
what matplotlib2tikz can do, or if you are just looking for more
information, then please visit `matplotlib2tikz's GitHub
page <https://github.com/nschloe/matplotlib2tikz>`__.

Testing
~~~~~~~

matplotlib2tikz has automatic unit testing to make sure that the
software doesn't accidentally get worse over time. In
``test/testfunctions/``, a number of test cases are specified. Those

-  run through matplotlib2tikz,
-  the resulting LaTeX file is compiled into a PDF (``pdflatex``),
-  the PDF is converted into a PNG (``pdftoppm``),
-  a perceptual hash is computed from the PNG and compared to a
   previously stored version.

To run the tests, just check out this repository and type

::

    pytest

The final pHash may depend on any of the tools used during the process.
For example, if your version of
`Pillow <https://pypi.python.org/pypi/Pillow/3.0.0>`__ is too old, the
pHash function might operate slightly differently and produce a slightly
different pHash, resulting in a failing test. If tests are failing on
your local machine, you should first make sure to have an up-to-date
Pillow.

If you would like to contribute a test, just take a look at the examples
in ``test/testfunctions/``. Essentially a test consists of three things:

-  a description,
-  a pHash, and
-  a function that creates the image in matplotlib.

Just add your file, add it to ``test/testfunction/__init__.py``, and run
the tests. A failing test will always print out the pHash, so you can
leave it empty in the first run and fill it in later to make the test
pass.

Distribution
~~~~~~~~~~~~

To create a new release

1. bump the ``__version__`` number,

2. publish to PyPi and GitHub:

   ::

       $ make publish

License
~~~~~~~

matplotlib2tikz is published under the `MIT
license <https://en.wikipedia.org/wiki/MIT_License>`__.

.. |Build Status| image:: https://travis-ci.org/nschloe/matplotlib2tikz.svg?branch=master
   :target: https://travis-ci.org/nschloe/matplotlib2tikz
.. |Code Health| image:: https://landscape.io/github/nschloe/matplotlib2tikz/master/landscape.png
   :target: https://landscape.io/github/nschloe/matplotlib2tikz/master
.. |codecov| image:: https://codecov.io/gh/nschloe/matplotlib2tikz/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/nschloe/matplotlib2tikz
.. |Documentation Status| image:: https://readthedocs.org/projects/matplotlib2tikz/badge/?version=latest
   :target: https://readthedocs.org/projects/matplotlib2tikz/?badge=latest
.. |PyPi Version| image:: https://img.shields.io/pypi/v/matplotlib2tikz.svg
   :target: https://pypi.python.org/pypi/matplotlib2tikz
.. |GitHub stars| image:: https://img.shields.io/github/stars/nschloe/matplotlib2tikz.svg?style=social&label=Star&maxAge=2592000
   :target: https://github.com/nschloe/matplotlib2tikz


