Welcome to diplotocus’ documentation!

Diplotocus is a python package designed to render animations of matplotlib objects, in a timeline style.

Here’s a quick example of the syntax of diplotocus:

import diplotocus as dpl
import numpy as np

#We define our Timeline, the object that handles all animations on our figure
tl = dpl.Timeline(xlim=(0,6*np.pi),ylim=(-1,1))

#We generate data points
x = np.linspace(0,6*np.pi,200)
y = np.cos(x)

#We create a plot() object
p = dpl.plot(x=x,y=y)

#We draw its data points sequentially
p.draw(duration=100)
tl.animate(p)

#We wait 25 frames
tl.wait(duration=25)

#We unzoom and move the axis to (0,0)
az = dpl.axis_zoom(zoom=0.5,duration=50)
am = dpl.axis_move(end_pos=(0,0),duration=50)
tl.animate((az,am))

#We hide the plot
p.hide(duration=100)
tl.animate(p)

#We render our video
tl.save_video(path='../_static/demo.mp4')

Diplotocus also features a Web GUI that lets you put your animations together visually, in a timeline-like manner:

Get started by Installing Diplotocus, and follow the Quick-Start guide.

Getting Started

• Installation
• Quick-start guide

Library reference

• Timeline
• Plot objects
  • SVG
• Animations
  • Animations of plot objects
    • Translate
    • Rotate
    • Scale
    • Tween
    • Morph
    • Draw
    • Sequence
  • Animations of figures and axes
    • Axis zoom
    • Axis limits
    • Axis move
    • Axis alpha
    • Figure width ratio
    • Figure height ratio
• Easing functions
  • easeLinear
  • Sine
    • easeInSine:
    • easeOutSine():
    • easeInOutSine():
  • Quadratic
    • easeInQuad():
    • easeOutQuad():
    • easeInOutQuad():
  • Cubic
    • easeInCubic():
    • easeOutCubic():
    • easeInOutCubic():
  • Quartic
    • easeInQuart():
    • easeOutQuart():
    • easeInOutQuart():
  • Quintic
    • easeInQuint():
    • easeOutQuint():
    • easeInOutQuint():
  • Exponential
    • easeInExpo():
    • easeOutExpo():
    • easeInOutExpo():
  • Circular
    • easeInCirc():
    • easeOutCirc():
    • easeInOutCirc():
  • Back
    • easeInBack():
    • easeOutBack():
    • easeInOutBack():
  • Elastic
    • easeInElastic():
    • easeOutElastic():
    • easeInOutElastic():
  • Bounce
    • easeInBounce():
    • easeOutBounce():
    • easeInOutBounce():
  • easeCubicBezier(x1,y1,x2,y2)
  • custom easing function
• GUI

API Reference

• API Reference
  • Core Module
  • GUI