Manim skill

Comprehensive guide for Manim Community - Python framework for creating mathematical animations and educational videos with programmatic control

by davila7·MIT license·★ 32,299 Stars on the repo·GitHub ↗

Use now

Files of Manim

davila7/main1 file shown
SKILL.md
Show the full text127 lines

Manim Community - Mathematical Animation Engine

Comprehensive skill set for creating mathematical animations using Manim Community, a Python framework for creating explanatory math videos programmatically, popularized by 3Blue1Brown.

When to use

Use this skill whenever you are dealing with Manim code to obtain domain-specific knowledge about:

  • Creating mathematical animations and visualizations
  • Building educational video content programmatically
  • Working with geometric shapes and transformations
  • Animating LaTeX equations and mathematical formulas
  • Creating graphs, charts, and coordinate systems
  • Implementing scene-based animation sequences
  • Rendering high-quality mathematical diagrams
  • Building explanatory visual content for teaching

Core Concepts

Manim allows you to create animations using:

  • Scenes: Canvas for your animations where you orchestrate mobjects
  • Mobjects: Mathematical objects that can be displayed (shapes, text, equations)
  • Animations: Transformations applied to mobjects (Write, Create, Transform, FadeIn)
  • Transforms: Morphing between different states of mobjects
  • LaTeX Integration: Native support for rendering mathematical notation
  • Python Simplicity: Use Python to programmatically specify animation behavior

Key Features

  • Precise mathematical object positioning and transformations
  • Native LaTeX rendering for equations and formulas
  • Extensive shape library (circles, rectangles, arrows, polygons)
  • Coordinate systems and function graphing
  • Boolean operations on geometric shapes
  • Camera controls and scene management
  • High-quality video rendering
  • IPython/Jupyter notebook integration
  • VS Code extension with live preview

How to use

Read individual rule files for detailed explanations and code examples:

Core Concepts

For additional topics including transforms, timing, shapes, coordinate systems, 3D animations, camera movement, and advanced features, refer to the comprehensive Manim Community documentation.

Quick Start Example

from manim import *

class SquareToCircle(Scene):
    def construct(self):
        # Create a square
        square = Square()
        square.set_fill(BLUE, opacity=0.5)

        # Create a circle
        circle = Circle()
        circle.set_fill(RED, opacity=0.5)

        # Animate square creation
        self.play(Create(square))
        self.wait(1)

        # Transform square into circle
        self.play(Transform(square, circle))
        self.wait(1)

        # Fade out
        self.play(FadeOut(square))

Render with: manim -pql script.py SquareToCircle

Best Practices

  1. Inherit from Scene - All animations should be in a class inheriting from Scene
  2. Use construct() method - Place all animation code inside the construct() method
  3. Think in layers - Add mobjects to the scene before animating them
  4. Use self.play() - Animate mobjects using self.play(Animation(...))
  5. Test with low quality - Use -ql flag for faster preview renders
  6. Leverage LaTeX - Use Tex() and MathTex() for mathematical notation
  7. Group related objects - Use VGroup to manage multiple mobjects together
  8. Preview frequently - Use -p flag to automatically open rendered videos

Command Line Usage

# Preview at low quality (fast)
manim -pql script.py SceneName

# Render at high quality
manim -pqh script.py SceneName

# Save last frame as image
manim -s script.py SceneName

# Render multiple scenes
manim script.py Scene1 Scene2

Resources

1---
2name: manim
3description: Comprehensive guide for Manim Community - Python framework for creating mathematical animations and educational videos with programmatic control
4version: 1.0.0
5author: manim-community
6repo: https://github.com/ManimCommunity/manim
7license: MIT
8tags: [Video, Python, Animation, Manim, Mathematical, Educational, Visualization, LaTeX, 3Blue1Brown]
9dependencies: [manim>=0.19.0, python>=3.8]
10---
11 
12# Manim Community - Mathematical Animation Engine
13 
14Comprehensive skill set for creating mathematical animations using Manim Community, a Python framework for creating explanatory math videos programmatically, popularized by 3Blue1Brown.
15 
16## When to use
17 
18Use this skill whenever you are dealing with Manim code to obtain domain-specific knowledge about:
19 
20- Creating mathematical animations and visualizations
21- Building educational video content programmatically
22- Working with geometric shapes and transformations
23- Animating LaTeX equations and mathematical formulas
24- Creating graphs, charts, and coordinate systems
25- Implementing scene-based animation sequences
26- Rendering high-quality mathematical diagrams
27- Building explanatory visual content for teaching
28 
29## Core Concepts
30 
31Manim allows you to create animations using:
32- **Scenes**: Canvas for your animations where you orchestrate mobjects
33- **Mobjects**: Mathematical objects that can be displayed (shapes, text, equations)
34- **Animations**: Transformations applied to mobjects (Write, Create, Transform, FadeIn)
35- **Transforms**: Morphing between different states of mobjects
36- **LaTeX Integration**: Native support for rendering mathematical notation
37- **Python Simplicity**: Use Python to programmatically specify animation behavior
38 
39## Key Features
40 
41- Precise mathematical object positioning and transformations
42- Native LaTeX rendering for equations and formulas
43- Extensive shape library (circles, rectangles, arrows, polygons)
44- Coordinate systems and function graphing
45- Boolean operations on geometric shapes
46- Camera controls and scene management
47- High-quality video rendering
48- IPython/Jupyter notebook integration
49- VS Code extension with live preview
50 
51## How to use
52 
53Read individual rule files for detailed explanations and code examples:
54 
55### Core Concepts
56- **[references/scenes.md](references/scenes.md)** - Creating scenes and organizing animations
57- **[references/mobjects.md](references/mobjects.md)** - Understanding mathematical objects and shapes
58- **[references/animations.md](references/animations.md)** - Core animation types and techniques
59- **[references/latex.md](references/latex.md)** - Rendering LaTeX equations and formulas
60 
61For additional topics including transforms, timing, shapes, coordinate systems, 3D animations, camera movement, and advanced features, refer to the comprehensive [Manim Community documentation](https://docs.manim.community/).
62 
63## Quick Start Example
64 
65```python
66from manim import *
67 
68class SquareToCircle(Scene):
69 def construct(self):
70 # Create a square
71 square = Square()
72 square.set_fill(BLUE, opacity=0.5)
73 
74 # Create a circle
75 circle = Circle()
76 circle.set_fill(RED, opacity=0.5)
77 
78 # Animate square creation
79 self.play(Create(square))
80 self.wait(1)
81 
82 # Transform square into circle
83 self.play(Transform(square, circle))
84 self.wait(1)
85 
86 # Fade out
87 self.play(FadeOut(square))
88```
89 
90Render with: `manim -pql script.py SquareToCircle`
91 
92## Best Practices
93 
941. **Inherit from Scene** - All animations should be in a class inheriting from Scene
952. **Use construct() method** - Place all animation code inside the construct() method
963. **Think in layers** - Add mobjects to the scene before animating them
974. **Use self.play()** - Animate mobjects using self.play(Animation(...))
985. **Test with low quality** - Use `-ql` flag for faster preview renders
996. **Leverage LaTeX** - Use Tex() and MathTex() for mathematical notation
1007. **Group related objects** - Use VGroup to manage multiple mobjects together
1018. **Preview frequently** - Use `-p` flag to automatically open rendered videos
102 
103## Command Line Usage
104 
105```bash
106# Preview at low quality (fast)
107manim -pql script.py SceneName
108 
109# Render at high quality
110manim -pqh script.py SceneName
111 
112# Save last frame as image
113manim -s script.py SceneName
114 
115# Render multiple scenes
116manim script.py Scene1 Scene2
117```
118 
119## Resources
120 
121- **Documentation**: https://docs.manim.community/
122- **Repository**: https://github.com/ManimCommunity/manim
123- **Examples Gallery**: https://docs.manim.community/en/stable/examples.html
124- **Discord Community**: https://www.manim.community/discord/
125- **3Blue1Brown Channel**: https://www.youtube.com/c/3blue1brown
126- **License**: MIT
127 

Discussion