ManimCommunity / manim
git clone https://github.com/ManimCommunity/manim.git
v0.22.0 · 13d ago
A community-maintained Python framework for creating mathematical animations.
+9
stars, 24h · #1,653
+~63
stars, 7 days · #2,075
+~270
stars, 30 days · #1,988
42k
★ total · +0% this week
3.2k
forks · 500 open issues
Star history (as recorded here)
LanguagePython
LicenseMIT
Created2020-05-19 (6y ago)
Last push1d ago
Watchers68
OwnerOrganization
GitHub topics
Links
- GitHub: github.com/ManimCommunity/manim
- Homepage: https://www.manim.community
- Releases · Issues · Hacker News mentions
README excerpt
An animation engine for explanatory math videos Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as demonstrated in the videos of 3Blue1Brown. > [!NOTE] > The community edition of Manim (ManimCE) is a version maintained and developed by the community. It was forked from 3b1b/manim, a tool originally created and open-sourced by Grant Sanderson, also creator of the 3Blue1Brown educational math videos. While Grant Sanderson continues to maintain his own repository, we recommend this version for its continued development, improved features, enhanced documentation, and more active community-driven maintenance. If you would like to study how Grant makes his videos, head over to his repository (3b1b/manim). ## Table of Contents: - Installation - Usage - Documentation - Docker - Help with Manim - Contributing - License ## Installation > [!CAUTION] > These instructions are for the community version _only_. Trying to use these instructions to install 3b1b/manim or instructions there to install this version will cause problems. Read this and decide which version you wish to install, then only follow the instructions for your desired version. Manim requires a few dependencies that must be installed prior to using it. If you want to try it out first before installing it locally, you can do so in our online Jupyter environment. For local installation, please visit the Documentation and follow the appropriate instructions for your operating system. ## Usage Manim is an extremely versatile package. The following is an example `Scene` you can construct: [code] In order to view the output of this scene, save the code in a file called `example.py`. Then, run the following in a terminal window: [code] You should see your native video player program pop up and play a simple scene in which a square is transformed into a circle. You may find some more simple examples within this GitHub repository. You can also visit the official gallery for more advanced examples. Manim also ships with a `%%manim` IPython magic which allows to use it conveniently in JupyterLab (as well as classic Jupyter) notebooks. See the corresponding documentation for some guidance and try it out online. ## Command line arguments The general usage of Manim is as follows: The `-p` flag in the command above is for previewing, meaning the video file will automatically open when it is done rendering. The `-ql` flag is for a faster rendering at a lower quality. Some other useful flags include: - `-s` to skip to the end and just show the final frame. - `-n ` to skip ahead to the `n`'th animation of a scene. - `-f` show the file in the file browser. For a thorough list of command line arguments, visit the documentation. ## Documentation Documentation is in progress at ReadTheDocs. ## Docker The community also maintains a docker image (`manimcommunity/manim`), which can be found on DockerHub. Instructions on how to install and use it ca