Welcome to tikzpy documentation!

Intro

Documentation of tikzpy. Build your TikZ drawings for latex with python. tikzpy is a python library that helps to build your tikZ pictures using python, instead of using directly tikZ sintaxis.

Main Index

Main tikzpy class

tikzpy object which contains the drawing info

tikZ = tikzpy.pytikz()

Points: add and edit reference spatial points in a 3D space

points tikZ.pto

2D shapes: add and edit 2D shapes and text in a 3D space

shapes tikZ.shp

plots: buld-in plots based on tikzpy

plots tikZ.plots

labels: add, edit, desactive labels of the different shapes

labels tikZ.lbl

colors: add and define custom colors and transparencies

colors tikZ.col

groups: add points and shapes to a group and operate with such container

groups tikZ.grp

Utilities included in tikzpy

files crawler: utility to crawl files by extension or name in folders

files_crawl tikzpy.files_crawl

Or check the reference index

First steps tikzpy

First steps and introductory examples on how to use tikzpy can be found in this section.

tikzpy: tikZ = tikzpy.pytikz() –> main class examples

Points: tikZ.pto –> points examples

2D shapes: tikZ.shp –> shapes examples

build-in plots: –> plots examples

labels: –> labels examples

colors: tikZ.col –> colors examples

groups: tikZ.grp –> group examples

Requirements or pre-requisites

Install Latex in Windows:

Install MikTex (miktex.org)

Install Latex in Ubuntu:

sudo apt-get install texlive-full

sudo apt-get install xzdec

sudo tlmgr install pgf

sudo tlmgr install tikz-cd

Packages: tikz, tikz-3dplot

TikZ libraries: shapes,arrows,decorations, decorations.pathmorphing,arrows.meta,patterns

Recomended to install ImageMagik and Ghostscript for png creation in Windows

Gallery of drawings and pictures performed using tikzpy

Code examples of drawings and pictures carried out using tikzpy. Contact and send us your drawings based of tikzpy if you want them to be included in this section.