Skip to main content

TikZ Figure Generator

Project description

TikZ Figure Generator

The following is a code example for creating a plot with this library::

import numpy as np
import tkz

K = 1000
x = np.linspace(0, 1.001, K)
y = 3*np.sin(2*np.pi*x) + 0.5*np.random.randn(K)
z = 3*np.cos(2*np.pi*x) + 0.5*np.random.randn(K)
u = np.zeros((2, K))
u[0, :] = np.row_stack((y, z)).min(axis=0) - 2
u[1, :] = np.row_stack((y, z)).max(axis=0) + 2

fig = tkz.Fig('test')
fig.xlabel = 'x axis'
fig.ylabel = 'y axis'
fig.path(x, u, thickness=0, opacity=0.2)
fig.path(x, y, label='first')
fig.path(x, z, label='second')
fig.render()

First, a figure object is created with tkz.Fig(). This object holds settings pertaining to the whole figure, like the width, height, and font size. Second, path objects are created with fig.path(), which creates a Path object and appends it to the list of path objects held by the Fig object. This object holds everything pertaining to a particular path, like the x and y arrays, the thickness, color, opacity, dash style, and label. To render the figure, pass the list of paths to the figure object with the .render() method. Note, the default setting is for the LaTeX file to be generated as a standalone file with its own document class declaration and preamble. When it is standalone, this Python library will then try to automatically compile the LaTeX file with the pdflatex command. If standalone is set to False then only the TikZ draw commands will be included. This file can then be input within the tikzpicture environment of another LaTeX file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tkz-0.0.5.tar.gz (21.0 kB view hashes)

Uploaded Source

Built Distribution

tkz-0.0.5-py3-none-any.whl (20.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page