You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as seen in the videos at [3Blue1Brown](https://www.3blue1brown.com/).
10
10
11
11
## Installation
12
-
Manim runs on python 3.7. You can install it from PyPI via pip
12
+
Manim runs on Python 3.7. You can install it from PyPI via pip:
13
13
14
14
```sh
15
15
pip3 install manimlib
@@ -23,7 +23,7 @@ You can now use it via the `manim` command. For example:
23
23
manim my_project.py MyScene
24
24
```
25
25
26
-
For more options, take a look at the “Using manim“ sections further below.
26
+
For more options, take a look at the [Using manim](#using-manim) sections further below.
2. Install Cairo. Download the wheel from https://www.lfd.uci.edu/~gohlke/pythonlibs/#pycairo. For most users, ``pycairo‑1.18.0‑cp37‑cp37m‑win32.whl`` will do fine.
42
+
2.[Install Cairo](https://www.lfd.uci.edu/~gohlke/pythonlibs/#pycairo). For most users, ``pycairo‑1.18.0‑cp37‑cp37m‑win32.whl`` will do fine.
@@ -91,9 +91,9 @@ The command needs to be run as root if your username is not in the docker group.
91
91
92
92
You can replace `example.scenes.py` with any relative path from your `INPUT_PATH`.
93
93
94
-
<img src=./manim_docker_diagram.png/>
94
+

95
95
96
-
After running the output will say files ready at `/tmp/output/`, which refers to path inside the container. Your OUTPUT_PATH is bind mounted to this `/tmp/output` so any changes made by the container to `/tmp/output` will be mirrored on your OUTPUT_PATH. `/media/` will be created in `OUTPUT_PATH`.
96
+
After running the output will say files ready at `/tmp/output/`, which refers to path inside the container. Your `OUTPUT_PATH` is bind mounted to this `/tmp/output` so any changes made by the container to `/tmp/output` will be mirrored on your `OUTPUT_PATH`. `/media/` will be created in `OUTPUT_PATH`.
97
97
98
98
`-p` won't work as manim would look forvideo playerin the container system, which it does not have.
The `-p` flag in the command above is for previewing, meaning the video file will automatically open when it is done rendering. The `-l` flag is for a faster rendering at a lower quality.
109
109
110
110
Some other useful flags include:
111
-
112
111
*`-s` to skip to the end and just show the final frame.
113
112
*`-n <number>` to skip ahead to the `n`'th animation of a scene.
114
113
* `-f` to show the file in finder (for OSX).
115
114
116
115
Set `MEDIA_DIR` environment variable to specify where the image and animation files will be written.
117
116
118
-
Look through the `old_projects` folder to see the code for previous 3b1b videos. Note, however, that developments are often made to the library without considering backwards compatibility with those old projects. To run an old project with a guarantee that it will work, you will have to go back to the commit which completed that project.
117
+
Look through the `old_projects` folder to see the code for previous 3b1b videos. Note, however, that developments are often made to the library without considering backwards compatibility with those old projects. To run an old project with a guarantee that it will work, you will have to go back to the commit which completed that project.
119
118
120
-
While developing a scene, the `-sp` flags are helpful to just see what things look like at the end without having to generate the full animation. It can also be helpful to use the `-n` flag to skip over some number of animations.
119
+
While developing a scene, the `-sp` flags are helpful to just see what things look like at the end without having to generate the full animation. It can also be helpful to use the `-n` flag to skip over some number of animations.
121
120
122
121
### Documentation
123
122
Documentation is in progress at [eulertour.com/learn/manim](https://www.eulertour.com/learn/manim/).
124
123
125
124
### Walkthrough
126
-
Todd Zimmerman put together a [tutorial](https://talkingphysics.wordpress.com/2019/01/08/getting-started-animating-with-manim-and-python-3-7/) on getting started with manim, which has been updated to run on python 3.7.
125
+
Todd Zimmerman put together a [tutorial](https://talkingphysics.wordpress.com/2019/01/08/getting-started-animating-with-manim-and-python-3-7/) on getting started with manim, which has been updated to run on Python 3.7.
127
126
128
127
### Live Streaming
129
128
To live stream your animations, simply run manim with the `--livestream` option.
@@ -141,8 +140,8 @@ them to manim.play(), e.g.
141
140
```
142
141
143
142
It is also possible to stream directly to Twitch. To do that simply pass
144
-
--livestream and --to-twitch to manim and specify the stream key with
145
-
--with-key. Then when you follow the above example the stream will directly
143
+
`--livestream` and `--to-twitch to manim` and specify the stream key with
144
+
`--with-key`. Then when you follow the above example the stream will directly
146
145
start on your Twitch channel (with no audio support).
147
146
148
147
@@ -151,6 +150,6 @@ Is always welcome. In particular, there is a dire need for tests and documentati
151
150
152
151
153
152
## License
154
-
All files in the directories active_projects and old_projects, which by and large generate the visuals for 3b1b videos, are copyright 3Blue1Brown.
153
+
All files in the directories `active_projects` and `old_projects`, which by and large generate the visuals for 3b1b videos, are copyright 3Blue1Brown.
155
154
156
155
The general purpose animation code found in the remainder of the repository, on the other hand, is under the MIT license.
0 commit comments