PyX Manual

Author:

Jörg Lehmann <joerg@pyx-project.org>, Michael Schindler <m-schindler@users.sourceforge.net>, André Wobst <wobsta@pyx-project.org>

Date:

2026/10/18

Abstract

PyX is a Python package for the creation of PostScript, PDF, and SVG files. It combines an abstraction of the PostScript drawing model with a TeX/LaTeX interface and direct Type 1 / OpenType font support. Complex tasks such as 2D and 3D publication-quality data plots in cartesian or curvilinear coordinates, path deformations, and box-and-connector diagrams are built on top of these primitives in a modular, extensible architecture.

• Introduction
  • What is PyX?
  • A first example
  • Organization of this manual
  • Installation
  • Configuration and file location

Basic graphics

• Basic graphics
  • Introduction
  • Path operations
  • Attributes: Styles and Decorations
  • The attribute system: attr
  • Styles: style
  • Decorators: deco
• Paths
  • Constructing paths
  • Path items
  • Class path
  • Normalized paths: normpath
  • Predefined shapes
• MetaPost-like paths
  • Example
  • Path construction: path
  • Knots
  • Links
• Deformers
  • Corner smoothing: smoothed
  • Parallel offset curves: parallel
  • Spring / coil paths: cycloid
• Canvas
  • Working with canvases
  • Class canvas
  • Class clip
• Documents
  • Creating single- and multi-page documents
  • Class page
  • Class paperformat
  • Class document and output writers

Text

• Text
  • Overview and Quick Start
  • Architecture of the TeX Interface
  • TeX and LaTeX Engines
  • Module-Level Functions
  • TeX Output Parsers and Error Handling
  • Text Attributes (Alignment, Parboxes, Math Mode, Font Size)
  • UnicodeEngine: Direct Font Rendering without TeX
  • Using the LaTeX graphics Bundle with PyX
  • Configuration and Debugging

Plotting

• Graphs
  • Introduction
  • Component Architecture and Canvas Layers
  • Module graph.graph: Graph Geometry
  • Module graph.data: Graph Data Sources
  • Module graph.style: Graph Styles
  • Module graph.key: Graph Keys (Legends)
• Axes
  • Component Architecture
  • Module graph.axis.axis: Axis Classes
  • Module graph.axis.timeaxis: Date and Time Axes
  • Module graph.axis.tick: Axis Ticks
  • Module graph.axis.parter: Axis Partitioners
  • Module graph.axis.texter: Axis Texters
  • Module graph.axis.painter: Axis Painters
  • Module graph.axis.rater: Axis Raters
  • Module graph.axis.positioner: Axis Positioners

Boxes and Connectors

• Module box: Convex box handling
  • Class polygon
  • Aligning and Tiling Lists of Boxes
  • Class rect
• Module connector
  • Geometry, Angles, and Bulges
  • Connector Classes

PostScript, PDF, SVG, and Bitmaps

• Module epsfile: EPS file inclusion
  • Class epsfile
• Module pdffile: PDF file inclusion
  • Class pdffile
• Module svgfile: SVG file inclusion
  • Class svgfile
  • Unparsed vs. Parsed Mode
  • Coordinate Resolution (resolution)
• Bitmaps
  • Introduction
  • Image Containers and File Readers
  • Placing Bitmaps on a Canvas

Basic classes and modules

• Module bbox
  • Constructing Bounding Boxes
  • Set Operations and Methods
• Module color
  • Color Models and Named Colors
  • Color Gradients
  • Transparency
• Module pattern
  • Class pattern
  • Predefined Hatching Patterns
• Module unit
  • Configuring Units and Scaling Factors
  • Class length
  • Predefined Length Constants
  • Conversion Functions
• Module trafo: Linear transformations
  • Mathematical Definition and Composition
  • Class trafo
  • Standard Transformation Subclasses

Appendix

• Appendix: Named colors
• Appendix: Named gradients
• Appendix: Path styles in style module
• Appendix: Arrows in deco module
• Module utils: Helper utilities
  • kwsplit()
  • merge_members_kwargs()