Welcome to Tulip Python documentation!

Tulip is an information visualization framework written in C++ dedicated to the analysis and visualization of graphs. Tulip Python is a set of modules that exposes to Python almost all the content of the Tulip C++ API. The bindings has been developed with the SIP tool from Riverbank. The main features provided by the bindings are listed below :

• creation and manipulation of graphs
• storage of data on graph elements (float, integer, boolean, color, size, coordinate, list, ...)
• application of algorithms of different types on graphs (layout, metric, clustering, ...)
• the ability to write Tulip plugins in pure Python

The bindings can be used inside the Tulip software GUI in order to run scripts on the current visualized graph. Starting from Tulip 3.6, the bindings can also be used outside Tulip through the classical Python interpreter.

Contents

• Getting started
  • Using the bindings from the Tulip Software GUI
    • Tulip Python IDE
    • Using the autocompletion to code faster
  • Using the bindings from the Python Interpreter
    • Installing the Tulip-Python modules from the Python Packaging Index
    • Setting up the environment from the Tulip software installation
  • Customizing the Python environment
• Release notes and API changes
  • Tulip-Python 4.10
    • Bugs fixes
    • New methods and API improvements
    • Documentation for Tulip C++ plugins
    • Improvements for working with Tulip color scales
  • Tulip-Python 4.9
    • Special syntax for automatic creation of graph properties through type inference
    • Improvements regarding the declaration and transmission of file / directory parameters for plugins
  • Tulip-Python 4.8.1
    • New methods for getting / setting graph properties values for nodes and edges added
  • Tulip-Python 4.8
    • Deprecation of the direct use of the tlp.DataSet class
    • Deprecation of the direct use of the tlp.StringCollection class
• Manual
  • Creating and manipulating graphs
    • Creating a new graph
    • Importing / exporting a graph using the TLP file format
    • Adding / Removing elements in the graph
    • Iterating over graph elements
  • Getting / Setting data on graph elements
    • Creating / Accessing / Deleting a graph property
    • Working with graph properties
  • Modifying the visual attributes of a graph
    • Graph layout
    • Rotations of the nodes
    • Selection
    • Colors of graph elements and labels
    • Sizes of graph elements
    • Shapes of graph elements
    • Labels of graph elements
    • Border width of graph elements and labels
    • Applying a texture to nodes or edges
  • Applying an algorithm on a graph
    • Calling a general algorithm on a graph
    • Calling a property algorithm on a graph
  • Graph/Properties observation
    • Observing a graph
    • Observing a graph property
  • Creating and manipulating Tulip visualizations with the tulipgui module
    • Using the module from the main Tulip GUI
    • Using the module with the classical Python interpreter
• Writing Tulip plugins in Python
  • Writing a general algorithm in Python
  • Writing a selection algorithm in Python
  • Writing a color algorithm in Python
  • Writing a measure algorithm in Python
  • Writing an integer algorithm in Python
  • Writing a layout algorithm in Python
  • Writing a size algorithm in Python
  • Writing an export module in Python
  • Writing an import module in Python
• Tulip plugins documentation
  • Algorithm
    • Acyclic
    • Biconnected
    • Connected
    • Curve edges
    • Delaunay triangulation
    • Directed Tree
    • Edge bundling
    • Equal Value
    • Free Tree
    • Hierarchical
    • Make Acyclic
    • Make Biconnected
    • Make Connected
    • Make Directed Tree
    • Make Planar Embedding
    • Make Simple
    • Outer Planar
    • Planar
    • Planar Embedding
    • Quotient Clustering
    • Reverse edges
    • Simple
    • Triconnected
    • Voronoi diagram
  • Coloring
    • Color Mapping
  • Export
    • GML Export
    • JSON Export
    • SVG Export
    • TLP Export
    • TLPB Export
  • Import
    • Adjacency Matrix
    • Complete General Graph
    • Complete Tree
    • Empty graph
    • File System Directory
    • GEXF
    • GML
    • Grid
    • Grid Approximation
    • JSON Import
    • Pajek
    • Planar Graph
    • Random General Graph
    • Random General Tree
    • Random Simple Graph
    • TLP Import
    • TLPB Import
    • UCINET
    • Uniform Random Binary Tree
    • Web Site
    • graphviz
  • Labeling
    • To labels
  • Layout
    • 3-Connected (Tutte)
    • Balloon (OGDF)
    • Bertault (OGDF)
    • Bubble Tree
    • Circular
    • Circular (OGDF)
    • Cone Tree
    • Connected Component Packing
    • Connected Component Packing (Polyomino)
    • Davidson Harel (OGDF)
    • Dendrogram
    • Dominance (OGDF)
    • FM^3 (OGDF)
    • Fast Multipole Embedder (OGDF)
    • Fast Multipole Multilevel Embedder (OGDF)
    • Fast Overlap Removal
    • Frutcherman Reingold (OGDF)
    • GEM (Frick)
    • GEM Frick (OGDF)
    • GRIP
    • Hierarchical Graph
    • Hierarchical Tree (R-T Extended)
    • Improved Walker
    • Improved Walker (OGDF)
    • Kamada Kawai (OGDF)
    • LinLog
    • MMM Example Fast Layout (OGDF)
    • MMM Example Nice Layout (OGDF)
    • MMM Example No Twist Layout (OGDF)
    • Mixed Model
    • Perfect aspect ratio
    • Pivot MDS (OGDF)
    • Planarization Grid (OGDF)
    • Planarization Layout (OGDF)
    • Random layout
    • Squarified Tree Map
    • Stress Majorization (OGDF)
    • Sugiyama (OGDF)
    • Tile To Rows Packing (OGDF)
    • Tree Leaf
    • Tree Radial
    • Upward Planarization (OGDF)
    • Visibility (OGDF)
  • Measure
    • Betweenness Centrality
    • Biconnected Component
    • Cluster
    • Connected Component
    • Convolution
    • Dag Level
    • Degree
    • Depth
    • Eccentricity
    • Id
    • K-Cores
    • Leaf
    • Link Communities
    • Louvain
    • MCL Clustering
    • Node
    • Page Rank
    • Path Length
    • Random metric
    • Strahler
    • Strength
    • Strength Clustering
    • Strongly Connected Component
    • Welsh & Powell
  • Resizing
    • Auto Sizing
    • Size Mapping
  • Selection
    • Induced Sub-Graph
    • Kruskal
    • Loop Selection
    • Multiple Edges Selection
    • Reachable Sub-Graph
    • Spanning Dag
    • Spanning Forest
• tulip module API
  • Utility functions
    • Graph management
    • Graph measures and functions
    • Geometry
    • Plugins Management
  • Graph elements classes
    • tlp.node
    • tlp.edge
  • The tlp.Graph class
    • Modification of the graph structure
    • Creation and Modification of the sub-graph hierarchy
    • Iterators on the graph structure
    • Information about the graph stucture
    • Create/Access graph properties
    • Application of algorithms
    • Update management
    • Meta-nodes management
  • Tulip datatypes
    • tlp.Vec3f
    • tlp.Vec4f
    • tlp.Vec4i
    • tlp.Coord
    • tlp.BoundingBox
    • tlp.Size
    • tlp.Color
    • tlp.ColorScale
    • tlp.StringCollection
    • tlp.DataSet
    • tlp.PluginProgress
  • Tulip observation mechanism
    • tlp.Event
    • tlp.GraphEvent
    • tlp.PropertyEvent
    • tlp.Observable
  • Graph properties classes
    • tlp.PropertyInterface
    • tlp.BooleanProperty
    • tlp.ColorProperty
    • tlp.NumericProperty
    • tlp.DoubleProperty
    • tlp.IntegerProperty
    • tlp.LayoutProperty
    • tlp.SizeProperty
    • tlp.StringProperty
    • tlp.BooleanVectorProperty
    • tlp.CoordVectorProperty
    • tlp.ColorVectorProperty
    • tlp.DoubleVectorProperty
    • tlp.IntegerVectorProperty
    • tlp.SizeVectorProperty
    • tlp.StringVectorProperty
  • Tulip plugins classes
    • tlp.WithParameter
    • tlp.Plugin
    • tlp.Algorithm
    • tlp.BooleanAlgorithm
    • tlp.ColorAlgorithm
    • tlp.DoubleAlgorithm
    • tlp.IntegerAlgorithm
    • tlp.LayoutAlgorithm
    • tlp.SizeAlgorithm
    • tlp.ImportModule
    • tlp.ExportModule
  • Graph test classes
    • tlp.SelfLoops
    • tlp.AcyclicTest
    • tlp.BiconnectedTest
    • tlp.ConnectedTest
    • tlp.OuterPlanarTest
    • tlp.PlanarityTest
    • tlp.SimpleTest
    • tlp.TreeTest
    • tlp.TriconnectedTest
  • Miscellaneous
    • tlp.TulipFontAwesome
• tulipogl module API
  • Parametric curves computation
  • tlpogl.GlGraphRenderingParameters
  • tlpogl.GlGraphInputData
• tulipgui module API
  • Utility functions
  • tlpgui.ColorScalesManager
  • tlpgui.Interactor
  • tlpgui.View
  • tlpgui.GlMainView
  • tlpgui.NodeLinkDiagramComponent
• tulipplugins module API

Indices and tables

• Index
• Search Page