Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ManimCommunity/manim

A community-maintained Python framework for creating mathematical animations.
https://github.com/ManimCommunity/manim

animations hacktoberfest manim math python

Last synced: 6 days ago
JSON representation

A community-maintained Python framework for creating mathematical animations.

Host: GitHub
URL: https://github.com/ManimCommunity/manim
Owner: ManimCommunity
License: mit
Created: 2020-05-19T02:37:13.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-10-30T01:08:30.000Z (6 days ago)
Last Synced: 2024-10-30T01:52:15.690Z (6 days ago)
Topics: animations, hacktoberfest, manim, math, python
Language: Python
Homepage: https://www.manim.community
Size: 39.6 MB
Stars: 25,408
Watchers: 156
Forks: 1,764
Open Issues: 441
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff

Awesome Lists containing this project

awesome-manim - GitHub
StarryDivineSky - ManimCommunity/manim
my-awesome - ManimCommunity/manim - 10 star:24.5k fork:1.7k A community-maintained Python framework for creating mathematical animations. (Python)

README

        


    

    


    


    

     

    

    

    

    

    

    

    

     

    

    


    


    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](https://www.3blue1brown.com/).

> [!NOTE]

> This repository is maintained by the Manim Community and is not associated with Grant Sanderson or 3Blue1Brown in any way (although we are definitely indebted to him for providing his work to the world). If you would like to study how Grant makes his videos, head over to his repository ([3b1b/manim](https://github.com/3b1b/manim)). This fork is updated more frequently than his, and it's recommended to use this fork if you'd like to use Manim for your own projects.

## Table of Contents:

-  [Installation](#installation)

-  [Usage](#usage)

-  [Documentation](#documentation)

-  [Docker](#docker)

-  [Help with Manim](#help-with-manim)

-  [Contributing](#contributing)

-  [License](#license)

## Installation

> [!CAUTION]

> These instructions are for the community version _only_. Trying to use these instructions to install [3b1b/manim](https://github.com/3b1b/manim) or instructions there to install this version will cause problems. Read [this](https://docs.manim.community/en/stable/faq/installation.html#why-are-there-different-versions-of-manim) 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](https://try.manim.community/).

For local installation, please visit the [Documentation](https://docs.manim.community/en/stable/installation.html)

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:

```python

from manim import *

class SquareToCircle(Scene):

    def construct(self):

        circle = Circle()

        square = Square()

        square.flip(RIGHT)

        square.rotate(-3 * TAU / 8)

        circle.set_fill(PINK, opacity=0.5)

        self.play(Create(square))

        self.play(Transform(square, circle))

        self.play(FadeOut(square))

```

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:

```sh

manim -p -ql example.py SquareToCircle

```

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](example_scenes). You can also visit the [official gallery](https://docs.manim.community/en/stable/examples.html) 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](https://docs.manim.community/en/stable/reference/manim.utils.ipython_magic.ManimMagic.html) for some guidance and

[try it out online](https://mybinder.org/v2/gh/ManimCommunity/jupyter_examples/HEAD?filepath=basic_example_scenes.ipynb).

## Command line arguments

The general usage of Manim is as follows:

![manim-illustration](https://raw.githubusercontent.com/ManimCommunity/manim/main/docs/source/_static/command.png)

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](https://docs.manim.community/en/stable/guides/configuration.html).

## Documentation

Documentation is in progress at [ReadTheDocs](https://docs.manim.community/).

## Docker

The community also maintains a docker image (`manimcommunity/manim`), which can be found [on DockerHub](https://hub.docker.com/r/manimcommunity/manim).

Instructions on how to install and use it can be found in our [documentation](https://docs.manim.community/en/stable/installation/docker.html).

## Help with Manim

If you need help installing or using Manim, feel free to reach out to our [Discord

Server](https://www.manim.community/discord/) or [Reddit Community](https://www.reddit.com/r/manim). If you would like to submit a bug report or feature request, please open an issue.

## Contributing

Contributions to Manim are always welcome. In particular, there is a dire need for tests and documentation. For contribution guidelines, please see the [documentation](https://docs.manim.community/en/stable/contributing.html).

However, please note that Manim is currently undergoing a major refactor. In general,

contributions implementing new features will not be accepted in this period.

The contribution guide may become outdated quickly; we highly recommend joining our

[Discord server](https://www.manim.community/discord/) to discuss any potential

contributions and keep up to date with the latest developments.

Most developers on the project use `poetry` for management. You'll want to have poetry installed and available in your environment.

Learn more about `poetry` at its [documentation](https://python-poetry.org/docs/) and find out how to install manim with poetry at the [manim dev-installation guide](https://docs.manim.community/en/stable/contributing/development.html) in the manim documentation.

## How to Cite Manim

We acknowledge the importance of good software to support research, and we note

that research becomes more valuable when it is communicated effectively. To

demonstrate the value of Manim, we ask that you cite Manim in your work.

Currently, the best way to cite Manim is to go to our

[repository page](https://github.com/ManimCommunity/manim) (if you aren't already) and

click the "cite this repository" button on the right sidebar. This will generate

a citation in your preferred format, and will also integrate well with citation managers.

## Code of Conduct

Our full code of conduct, and how we enforce it, can be read on [our website](https://docs.manim.community/en/stable/conduct.html).

## License

The software is double-licensed under the MIT license, with copyright by 3blue1brown LLC (see LICENSE), and copyright by Manim Community Developers (see LICENSE.community).