public-mirrors/3b1b-manim
1
0
Fork 0
mirror of https://github.com/3b1b/manim.git synced 2025-04-13 09:47:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Deploying to gh-pages from @ dba0550da5 🚀

Browse source
This commit is contained in:
3b1b 2021-02-11 18:56:34 +00:00
parent c407206ba0
commit 21ea50ad9d
30 changed files with 422 additions and 408 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
_sources/documentation/custom_default.rst.txt → _sources/documentation/custom_config.rst.txt
View file

@ -1,4 +1,4 @@
custom_default
custom_config
==============
``directories``
@ -18,12 +18,13 @@ custom_default
file and saved the last frame, then the final directory structure will be like:
.. code-block:: text
:emphasize-lines: 8, 10
:emphasize-lines: 9, 11
manim/
├── manimlib/
│ ├── animation/
│ ├── ...
│ ├── default_config.yml
│ └── window.py
├── output/
│ ├── images
@ -31,18 +32,18 @@ custom_default
│ └── videos
│ └── Scene1.mp4
├── code.py
├── custom_default.yml
└── manim.py
└── custom_config.yml
But if you set ``mirror_module_path`` to ``True``, the directory structure will be:
.. code-block:: text
:emphasize-lines: 7
:emphasize-lines: 8
manim/
├── manimlib/
│ ├── animation/
│ ├── ...
│ ├── default_config.yml
│ └── window.py
├── output/
│ └── code/
@ -51,8 +52,7 @@ custom_default
│ └── videos
│ └── Scene1.mp4
├── code.py
├── custom_default.yml
└── manim.py
└── custom_config.yml
- ``raster_images``
The directory for storing raster images to be used in the code (including

27
_sources/getting_started/configuration.rst.txt
View file

@ -4,14 +4,16 @@ CLI flags and configuration
Command Line Interface
----------------------
To run manim, you need to enter the directory at the same level as ``manim.py``
To run manim, you need to enter the directory at the same level as ``manimlib/``
and enter the command in the following format into terminal:
.. code-block:: sh
python manim.py <code>.py <Scene> <flags>
manimgl <code>.py <Scene> <flags>
# or
manim-render <code>.py <Scene> <flags>
- ``<code>.py`` : The python file you wrote. Needs to be at the same level as ``manim.py``, otherwise you need to use an absolute path or a relative path.
- ``<code>.py`` : The python file you wrote. Needs to be at the same level as ``manimlib/``, otherwise you need to use an absolute path or a relative path.
- ``<Scene>`` : The scene you want to render here. If it is not written or written incorrectly, it will list all for you to choose. And if there is only one ``Scene`` in the file, this class will be rendered directly.
- ``<flags>`` : CLI flags.
@ -48,6 +50,7 @@ flag abbr function
``--write_all`` ``-a`` Write all the scenes from a file
``--open`` ``-o`` Automatically open the saved file once its done
``--finder`` Show the output file in finder
``--config`` Guide for automatic configuration
``--file_name FILE_NAME`` Name for the movie or image file
``--start_at_animation_number START_AT_ANIMATION_NUMBER`` ``-n`` Start rendering not from the first animation, but from another, specified by its index. If you passin two comma separated values, e.g. "3,6", it will end the rendering at the second value.
``--resolution RESOLUTION`` ``-r`` Resolution, passed as "WxH", e.g. "1920x1080"
@ -57,15 +60,15 @@ flag abbr function
``--video_dir VIDEO_DIR`` directory to write video
========================================================== ====== =================================================================================================================================================================================================
custom_default
custom_config
--------------
In order to perform more configuration (about directories, etc.) and permanently
change the default value (you don't have to add flags to the command every time),
you can modify ``custom_default.yml``. The meaning of each option is in
page :doc:`../documentation/custom_default`.
you can modify ``custom_config.yml``. The meaning of each option is in
page :doc:`../documentation/custom_config`.
You can also use different ``custom_default.yml`` for different directories, such as
You can also use different ``custom_config.yml`` for different directories, such as
following the directory structure:
.. code-block:: text
@ -74,13 +77,13 @@ following the directory structure:
├── manimlib/
│ ├── animation/
│ ├── ...
│ ├── default_config.yml
│ └── window.py
├── project/
│ ├── code.py
│ └── custom_default.yml
├── custom_default.yml
└── manim.py
│ └── custom_config.yml
└── custom_config.yml
When you enter the ``project/`` folder and run ``python ../manim.py code.py <Scene>``,
it will overwrite ``manim/custom_default.yml`` with ``custom_default.yml``
When you enter the ``project/`` folder and run ``manimgl code.py <Scene>``,
it will overwrite ``manim/custom_config.yml`` with ``custom_config.yml``
in the ``project`` folder.

4
_sources/getting_started/example_scenes.rst.txt
View file

@ -11,7 +11,7 @@ InteractiveDevlopment
.. manim-example:: InteractiveDevlopment
:media: ../_static/example_scenes/InteractiveDevlopment.mp4
from manimlib.imports import *
from manimlib import *
class InteractiveDevlopment(Scene):
def construct(self):
@ -572,7 +572,7 @@ SurfaceExample
# be interpreted as the side towards the light, and away from
# the light. These can be either urls, or paths to a local file
# in whatever you've set as the image directory in
# the custom_defaults.yml file
# the custom_config.yml file
# day_texture = "EarthTextureMap"
# night_texture = "NightEarthTextureMap"

25
_sources/getting_started/installation.rst.txt
View file

@ -19,10 +19,12 @@ that directory execute:
.. code-block:: sh
# Install python requirements
pip install -r requirements.txt
pip install -e .
# Try it out
python -m manim example_scenes.py OpeningManimExample
manimgl example_scenes.py OpeningManimExample
# or
manim-render example_scenes.py OpeningManimExample
If you run the above command and no error message appears,
then you have successfully installed all the environments required by manim.
@ -40,8 +42,8 @@ Directly (Windows)
git clone https://github.com/3b1b/manim.git
cd manim
pip install -r requirements.txt
python manim.py example_scenes.py OpeningManimExample
pip install -e .
manimgl example_scenes.py OpeningManimExample
For Anaconda
------------
@ -53,15 +55,6 @@ For Anaconda
git clone https://github.com/3b1b/manim.git
cd manim
conda env create -f environment.yml
Using virtualenv and virtualenvwrapper
--------------------------------------
After installing ``virtualenv`` and ``virtualenvwrapper``
.. code-block:: sh
git clone https://github.com/3b1b/manim.git
mkvirtualenv -a manim -r requirements.txt manim
python -m manim example_scenes.py OpeningManimExample
conda create -n manim python=3.8
conda activate manim
pip install -e .

28
_sources/getting_started/quickstart.rst.txt
View file

@ -14,9 +14,9 @@ directory structure:
├── manimlib/
│ ├── animation/
│ ├── ...
│ ├── default_config.yml
│ └── window.py
├── custom_default.yml
├── manim.py
├── custom_config.yml
└── start.py
And paste the following code (I will explain the function of each line in detail later):
@ -24,7 +24,7 @@ And paste the following code (I will explain the function of each line in detail
.. code-block:: python
:linenos:
from manimlib.imports import *
from manimlib import *
class SquareToCircle(Scene):
def construct(self):
@ -38,7 +38,7 @@ And run this command:
.. code-block:: sh
python manim.py start.py SquareToCircle
manimgl start.py SquareToCircle
A window will pop up on the screen. And then you can :
@ -53,7 +53,7 @@ Run this command again:
.. code-block:: sh
python manim.py start.py SquareToCircle -os
manimgl start.py SquareToCircle -os
At this time, no window will pop up. When the program is finished, this rendered
image will be automatically opened (saved in the subdirectory ``images/`` of the same
@ -70,9 +70,15 @@ Next, let's take a detailed look at what each row does.
**Line 1**:
.. code-block:: python
<<<<<<< HEAD
from manimlib.imports import *
=======
from manimlib import *
>>>>>>> TonyCrane-package-improve
This will import all the classes that may be used when using manim.
**Line 3**:
@ -129,7 +135,7 @@ Let's change some codes and add some animations to make videos instead of just p
.. code-block:: python
:linenos:
from manimlib.imports import *
from manimlib import *
class SquareToCircle(Scene):
def construct(self):
@ -147,14 +153,14 @@ Run this command this time:
.. code-block:: sh
python manim.py start.py SquareToCircle
manimgl start.py SquareToCircle
The pop-up window will play animations of drawing a square and transforming
it into a circle. If you want to save this video, run:
.. code-block:: sh
python manim.py start.py SquareToCircle -ow
manimgl start.py SquareToCircle -o
This time there will be no pop-up window, but the video file (saved in the subdirectory
``videos/`` of the same level directory of ``start.py`` by default) will be automatically
@ -209,7 +215,11 @@ at the end of the code to enable interaction:
self.embed()
<<<<<<< HEAD
Then run ``python manim.py start.py SquareToCircle``.
=======
Then run ``manimgl start.py SquareToCircle``.
>>>>>>> TonyCrane-package-improve
After the previous animation is executed, the ipython terminal will be opened on
the command line. After that, you can continue to write code in it, and the statement
@ -245,7 +255,7 @@ empty scene containing only ``self.embed()``, you can directly run the following
.. code-block:: sh
python manim.py
manimgl
You succeeded!
--------------

200
_sources/getting_started/structure.rst.txt
View file

@ -12,107 +12,105 @@ Below is the directory structure of manim:
.. code-block:: text
├── manim.py # Manim command entry
├── custom_default.yml # Default configuration
└── manimlib/ # manim library
├── __init__.py # run from here
├── config.py # Process CLI flags
├── constants.py # Defined some constants
├── extract_scene.py # Extract and run the scene
├── imports.py # Import all required files in manimlib
├── shader_wrapper.py # Shaders' Wrapper for convenient control
├── window.py # Playback window
├── tex_templates/ # Templates preset for LaTeX
│ ├── tex_templates.tex # Tex template (will be compiled with latex, default)
│ └── ctex_templates.tex # Tex template that support Chinese (will be compiled with xelatex)
├── camera/
│ └── camera.py # Including Camera and CameraFrame
├── scene/
│ ├── scene_file_writer.py # Used to write scene to video file
│ ├── scene.py # The basic Scene class
│ ├── three_d_scene.py # Three-dimensional scene
│ ├── graph_scene.py # GraphScene (with coordinate axis)
│ ├── reconfigurable_scene.py
│ ├── sample_space_scene.py # Probability related sample space scene
│ └── vector_space_scene.py # Vector field scene
├── animation/
│ ├── animation.py # The basic class of animation
│ ├── composition.py # Animation group
│ ├── creation.py # Animation related to Create
│ ├── fading.py # Fade related animation
│ ├── growing.py # Animation related to Grow
│ ├── indication.py # Some animations for emphasis
│ ├── movement.py # Animation related to movement
│ ├── numbers.py # Realize changes to DecimalNumber
│ ├── rotation.py # Animation related to rotation
│ ├── specialized.py # Some uncommon animations for special projects
│ ├── transform_matching_parts.py # Transform which can automatically match parts
│ ├── transform.py # Some Transforms
│ └── update.py # Realize update from function
├── mobject/
│ ├── mobject.py # The basic class of all math object
│ ├── types/ # 4 types of mobject
│ │ ├── dot_cloud.py # Dot cloud (an subclass of PMobject)
│ │ ├── image_mobject.py # Insert pictures
│ │ ├── point_cloud_mobject.py # PMobject (mobject composed of points)
│ │ ├── surface.py # ParametricSurface
│ │ └── vectorized_mobject.py # VMobject (vectorized mobject)
│ ├── svg/ # mobject related to svg
│ │ ├── svg_mobject.py # SVGMobject
│ │ ├── brace.py # Brace
│ │ ├── drawings.py # Some special mobject of svg image
│ │ ├── tex_mobject.py # Tex and TexText implemented by LaTeX
│ │ └── text_mobject.py # Text implemented by cairo
│ ├── changing.py # Dynamically changing mobject
│ ├── coordinate_systems.py # coordinate system
│ ├── frame.py # mobject related to frame
│ ├── functions.py # ParametricFunction
│ ├── geometry.py # geometry mobjects
│ ├── matrix.py # matrix
│ ├── mobject_update_utils.py # some defined updater
│ ├── number_line.py # Number line
│ ├── numbers.py # Numbers that can be changed
│ ├── probability.py # mobject related to probability
│ ├── shape_matchers.py # mobject adapted to the size of other objects
│ ├── three_dimensions.py # Three-dimensional objects
│ ├── value_tracker.py # ValueTracker which storage number
│ └── vector_field.py # VectorField
├── once_useful_constructs/ # 3b1b's Common scenes written for some videos
│ └── ...
├── shaders/ # GLSL scripts for rendering
│ ├── simple_vert.glsl # a simple glsl script for position
│ ├── insert/ # glsl scripts to be inserted in other glsl scripts
│ │ ├── NOTE.md # explain how to insert glsl scripts
│ │ └── ... # useful scripts
│ ├── image/ # glsl for images
│ │ └── ... # containing shaders for vertex and fragment
│ ├── quadratic_bezier_fill/ # glsl for the fill of quadratic bezier curve
│ │ └── ... # containing shaders for vertex, fragment and geometry
│ ├── quadratic_bezier_stroke/ # glsl for the stroke of quadratic bezier curve
│ │ └── ... # containing shaders for vertex, fragment and geometry
│ ├── surface/ # glsl for surfaces
│ │ └── ... # containing shaders for vertex and fragment
│ ├── textured_surface/ # glsl for textured_surface
│ │ └── ... # containing shaders for vertex and fragment
│ └── true_dot/ # glsl for a dot
│ └── ... # containing shaders for vertex, fragment and geometry
└── utils/ # Some useful utility functions
├── bezier.py # For bezier curve
├── color.py # For color
├── config_ops.py # Process CONFIG
├── customization.py # Read from custom_default.yml
├── debug.py # Utilities for debugging in program
├── family_ops.py # Process family members
├── file_ops.py # Process files and directories
├── images.py # Read image
├── iterables.py # Functions related to list/dictionary processing
├── paths.py # Curve path
├── rate_functions.py # Some defined rate_functions
├── simple_functions.py # Some commonly used functions
├── sounds.py # Process sounds
├── space_ops.py # Space coordinate calculation
├── strings.py # Process strings
└── tex_file_writing.py # Use LaTeX to write strings as svg
manimlib/ # manim library
├── __init__.py
├── __main__.py
├── default_config.yml # Default configuration file
├── config.py # Process CLI flags
├── constants.py # Defined some constants
├── extract_scene.py # Extract and run the scene
├── shader_wrapper.py # Shaders' Wrapper for convenient control
├── window.py # Playback window
├── tex_templates/ # Templates preset for LaTeX
│ ├── tex_templates.tex # Tex template (will be compiled with latex, default)
│ └── ctex_templates.tex # Tex template that support Chinese (will be compiled with xelatex)
├── camera/
│ └── camera.py # Including Camera and CameraFrame
├── scene/
│ ├── scene_file_writer.py # Used to write scene to video file
│ ├── scene.py # The basic Scene class
│ ├── three_d_scene.py # Three-dimensional scene
│ ├── sample_space_scene.py # Probability related sample space scene
│ └── vector_space_scene.py # Vector field scene
├── animation/
│ ├── animation.py # The basic class of animation
│ ├── composition.py # Animation group
│ ├── creation.py # Animation related to Create
│ ├── fading.py # Fade related animation
│ ├── growing.py # Animation related to Grow
│ ├── indication.py # Some animations for emphasis
│ ├── movement.py # Animation related to movement
│ ├── numbers.py # Realize changes to DecimalNumber
│ ├── rotation.py # Animation related to rotation
│ ├── specialized.py # Some uncommon animations for special projects
│ ├── transform_matching_parts.py # Transform which can automatically match parts
│ ├── transform.py # Some Transforms
│ └── update.py # Realize update from function
├── mobject/
│ ├── mobject.py # The basic class of all math object
│ ├── types/ # 4 types of mobject
│ │ ├── dot_cloud.py # Dot cloud (an subclass of PMobject)
│ │ ├── image_mobject.py # Insert pictures
│ │ ├── point_cloud_mobject.py # PMobject (mobject composed of points)
│ │ ├── surface.py # ParametricSurface
│ │ └── vectorized_mobject.py # VMobject (vectorized mobject)
│ ├── svg/ # mobject related to svg
│ │ ├── svg_mobject.py # SVGMobject
│ │ ├── brace.py # Brace
│ │ ├── drawings.py # Some special mobject of svg image
│ │ ├── tex_mobject.py # Tex and TexText implemented by LaTeX
│ │ └── text_mobject.py # Text implemented by cairo
│ ├── changing.py # Dynamically changing mobject
│ ├── coordinate_systems.py # coordinate system
│ ├── frame.py # mobject related to frame
│ ├── functions.py # ParametricFunction
│ ├── geometry.py # geometry mobjects
│ ├── matrix.py # matrix
│ ├── mobject_update_utils.py # some defined updater
│ ├── number_line.py # Number line
│ ├── numbers.py # Numbers that can be changed
│ ├── probability.py # mobject related to probability
│ ├── shape_matchers.py # mobject adapted to the size of other objects
│ ├── three_dimensions.py # Three-dimensional objects
│ ├── value_tracker.py # ValueTracker which storage number
│ └── vector_field.py # VectorField
├── once_useful_constructs/ # 3b1b's Common scenes written for some videos
│ └── ...
├── shaders/ # GLSL scripts for rendering
│ ├── simple_vert.glsl # a simple glsl script for position
│ ├── insert/ # glsl scripts to be inserted in other glsl scripts
│ │ ├── NOTE.md # explain how to insert glsl scripts
│ │ └── ... # useful scripts
│ ├── image/ # glsl for images
│ │ └── ... # containing shaders for vertex and fragment
│ ├── quadratic_bezier_fill/ # glsl for the fill of quadratic bezier curve
│ │ └── ... # containing shaders for vertex, fragment and geometry
│ ├── quadratic_bezier_stroke/ # glsl for the stroke of quadratic bezier curve
│ │ └── ... # containing shaders for vertex, fragment and geometry
│ ├── surface/ # glsl for surfaces
│ │ └── ... # containing shaders for vertex and fragment
│ ├── textured_surface/ # glsl for textured_surface
│ │ └── ... # containing shaders for vertex and fragment
│ └── true_dot/ # glsl for a dot
│ └── ... # containing shaders for vertex, fragment and geometry
└── utils/ # Some useful utility functions
├── bezier.py # For bezier curve
├── color.py # For color
├── config_ops.py # Process CONFIG
├── customization.py # Read from custom_config.yml
├── debug.py # Utilities for debugging in program
├── family_ops.py # Process family members
├── file_ops.py # Process files and directories
├── images.py # Read image
├── init_config.py # Configuration guide
├── iterables.py # Functions related to list/dictionary processing
├── paths.py # Curve path
├── rate_functions.py # Some defined rate_functions
├── simple_functions.py # Some commonly used functions
├── sounds.py # Process sounds
├── space_ops.py # Space coordinate calculation
├── strings.py # Process strings
└── tex_file_writing.py # Use LaTeX to write strings as svg
Inheritance structure of manim's classes
----------------------------------------

2
_sources/index.rst.txt
View file

@ -25,7 +25,7 @@ And here is a Chinese version of this documentation: https://manim.ml/shaders
:caption: Documentation
documentation/constants
documentation/custom_default
documentation/custom_config
.. toctree::
:maxdepth: 2

8
development/about.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?771651f2559f07cbf6092fc4">
<link rel="stylesheet" href="../_static/pygments.css?771651f2559f07cbf6092fc4">
<link rel="stylesheet" href="../_static/styles/default.css?c80a934c52a7e2f3f284a485">
<link rel="stylesheet" href="../_static/pygments.css?c80a934c52a7e2f3f284a485">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?771651f2559f07cbf6092fc4"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?c80a934c52a7e2f3f284a485"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul class="current">

14
development/changelog.html
View file

@ -1,15 +1,15 @@
<!doctype html>
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Contributing" href="contributing.html" /><link rel="prev" title="custom_default" href="../documentation/custom_default.html" />
<meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Contributing" href="contributing.html" /><link rel="prev" title="custom_config" href="../documentation/custom_config.html" />
<link rel="shortcut icon" href="../_static/icon.png"/><meta name="generator" content="sphinx-3.0.3, furo 2020.10.05.beta9"/>
<title>Changelog - manim documentation</title>
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?a6e7871b48197986075fbb5c">
<link rel="stylesheet" href="../_static/pygments.css?a6e7871b48197986075fbb5c">
<link rel="stylesheet" href="../_static/styles/default.css?ff10aee26cc2b6b61f63dcd4">
<link rel="stylesheet" href="../_static/pygments.css?ff10aee26cc2b6b61f63dcd4">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?a6e7871b48197986075fbb5c"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?ff10aee26cc2b6b61f63dcd4"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul class="current">
@ -138,14 +138,14 @@
</div>
<svg><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="../documentation/custom_default.html">
<a class="prev-page" href="../documentation/custom_config.html">
<svg><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">custom_default</div>
<div class="title">custom_config</div>
</div>
</a>

8
development/contributing.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?39b99ac6366ff9dbb009a33d">
<link rel="stylesheet" href="../_static/pygments.css?39b99ac6366ff9dbb009a33d">
<link rel="stylesheet" href="../_static/styles/default.css?d1e6a05ddadfc673655b663b">
<link rel="stylesheet" href="../_static/pygments.css?d1e6a05ddadfc673655b663b">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?39b99ac6366ff9dbb009a33d"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?d1e6a05ddadfc673655b663b"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul class="current">

8
documentation/animation/index.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../../_static/copybutton.css" />
<link rel="stylesheet" href="../../_static/custom.css" />
<link rel="stylesheet" href="../../_static/colors.css" />
<link rel="stylesheet" href="../../_static/styles/default.css?4a544c696eafaf5c4a31d567">
<link rel="stylesheet" href="../../_static/pygments.css?4a544c696eafaf5c4a31d567">
<link rel="stylesheet" href="../../_static/styles/default.css?55a59d32da9aa3655900d7a9">
<link rel="stylesheet" href="../../_static/pygments.css?55a59d32da9aa3655900d7a9">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../../_static/language_data.js" defer></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?4a544c696eafaf5c4a31d567"></script></head>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?55a59d32da9aa3655900d7a9"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>

8
documentation/camera/index.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../../_static/copybutton.css" />
<link rel="stylesheet" href="../../_static/custom.css" />
<link rel="stylesheet" href="../../_static/colors.css" />
<link rel="stylesheet" href="../../_static/styles/default.css?06c93df036aa2d88fd9d2786">
<link rel="stylesheet" href="../../_static/pygments.css?06c93df036aa2d88fd9d2786">
<link rel="stylesheet" href="../../_static/styles/default.css?5590b56e9f4e94938b722b7b">
<link rel="stylesheet" href="../../_static/pygments.css?5590b56e9f4e94938b722b7b">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../../_static/language_data.js" defer></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?06c93df036aa2d88fd9d2786"></script></head>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?5590b56e9f4e94938b722b7b"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>

14
documentation/constants.html
View file

@ -1,15 +1,15 @@
<!doctype html>
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="custom_default" href="custom_default.html" /><link rel="prev" title="What’s new" href="../getting_started/whatsnew.html" />
<meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="custom_config" href="custom_config.html" /><link rel="prev" title="What’s new" href="../getting_started/whatsnew.html" />
<link rel="shortcut icon" href="../_static/icon.png"/><meta name="generator" content="sphinx-3.0.3, furo 2020.10.05.beta9"/>
<title>constants - manim documentation</title>
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?e55b2d5a3d9c44a412253709">
<link rel="stylesheet" href="../_static/pygments.css?e55b2d5a3d9c44a412253709">
<link rel="stylesheet" href="../_static/styles/default.css?add208f83f9222357d94b237">
<link rel="stylesheet" href="../_static/pygments.css?add208f83f9222357d94b237">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?e55b2d5a3d9c44a412253709"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?add208f83f9222357d94b237"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul class="current">
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
@ -304,12 +304,12 @@ they are only used inside manim.</p>
<footer>
<div class="related-pages">
<a class="next-page" href="custom_default.html">
<a class="next-page" href="custom_config.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">custom_default</div>
<div class="title">custom_config</div>
</div>
<svg><use href="#svg-arrow-right"></use></svg>
</a>

24
documentation/custom_default.html → documentation/custom_config.html
View file

@ -4,12 +4,12 @@
<meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Changelog" href="../development/changelog.html" /><link rel="prev" title="constants" href="constants.html" />
<link rel="shortcut icon" href="../_static/icon.png"/><meta name="generator" content="sphinx-3.0.3, furo 2020.10.05.beta9"/>
<title>custom_default - manim documentation</title>
<title>custom_config - manim documentation</title>
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?9fb2a5ed21eafadaec1e5006">
<link rel="stylesheet" href="../_static/pygments.css?9fb2a5ed21eafadaec1e5006">
<link rel="stylesheet" href="../_static/styles/default.css?e77e3db0401f1239118a6a84">
<link rel="stylesheet" href="../_static/pygments.css?e77e3db0401f1239118a6a84">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?9fb2a5ed21eafadaec1e5006"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?e77e3db0401f1239118a6a84"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="constants.html">constants</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">custom_default</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
@ -120,8 +120,8 @@
<label class="toc-overlay-icon" for="__toc">
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
<div class="section" id="custom-default">
<h1>custom_default<a class="headerlink" href="#custom-default" title="Permalink to this headline"></a></h1>
<div class="section" id="custom-config">
<h1>custom_config<a class="headerlink" href="#custom-config" title="Permalink to this headline"></a></h1>
<div class="section" id="directories">
<h2><code class="docutils literal notranslate"><span class="pre">directories</span></code><a class="headerlink" href="#directories" title="Permalink to this headline"></a></h2>
<ul>
@ -142,6 +142,7 @@ file and saved the last frame, then the final directory structure will be like:<
├── manimlib/
│ ├── animation/
│ ├── ...
│ ├── default_config.yml
│ └── window.py
├── output/
│ ├── images
@ -149,8 +150,7 @@ file and saved the last frame, then the final directory structure will be like:<
</span> │ └── videos
<span class="hll"> │ └── Scene1.mp4
</span> ├── code.py
├── custom_default.yml
└── manim.py
└── custom_config.yml
</pre></div>
</div>
<p>But if you set <code class="docutils literal notranslate"><span class="pre">mirror_module_path</span></code> to <code class="docutils literal notranslate"><span class="pre">True</span></code>, the directory structure will be:</p>
@ -158,6 +158,7 @@ file and saved the last frame, then the final directory structure will be like:<
├── manimlib/
│ ├── animation/
│ ├── ...
│ ├── default_config.yml
│ └── window.py
├── output/
<span class="hll"> │ └── code/
@ -166,8 +167,7 @@ file and saved the last frame, then the final directory structure will be like:<
│ └── videos
│ └── Scene1.mp4
├── code.py
├── custom_default.yml
└── manim.py
└── custom_config.yml
</pre></div>
</div>
</dd>
@ -338,7 +338,7 @@ effectively has cuts at all the places you might want.</p>
</div>
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">custom_default</a><ul>
<li><a class="reference internal" href="#">custom_config</a><ul>
<li><a class="reference internal" href="#directories"><code class="docutils literal notranslate"><span class="pre">directories</span></code></a></li>
<li><a class="reference internal" href="#tex"><code class="docutils literal notranslate"><span class="pre">tex</span></code></a></li>
<li><a class="reference internal" href="#universal-import-line"><code class="docutils literal notranslate"><span class="pre">universal_import_line</span></code></a></li>

8
documentation/mobject/index.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../../_static/copybutton.css" />
<link rel="stylesheet" href="../../_static/custom.css" />
<link rel="stylesheet" href="../../_static/colors.css" />
<link rel="stylesheet" href="../../_static/styles/default.css?004b6336c11c17eaf1276de0">
<link rel="stylesheet" href="../../_static/pygments.css?004b6336c11c17eaf1276de0">
<link rel="stylesheet" href="../../_static/styles/default.css?40f8413cc940e381287df0e7">
<link rel="stylesheet" href="../../_static/pygments.css?40f8413cc940e381287df0e7">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../../_static/language_data.js" defer></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?004b6336c11c17eaf1276de0"></script></head>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?40f8413cc940e381287df0e7"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>

8
documentation/scene/index.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../../_static/copybutton.css" />
<link rel="stylesheet" href="../../_static/custom.css" />
<link rel="stylesheet" href="../../_static/colors.css" />
<link rel="stylesheet" href="../../_static/styles/default.css?1101f7c25c847cdc1dde4893">
<link rel="stylesheet" href="../../_static/pygments.css?1101f7c25c847cdc1dde4893">
<link rel="stylesheet" href="../../_static/styles/default.css?754b77fee1b1a86631f10e95">
<link rel="stylesheet" href="../../_static/pygments.css?754b77fee1b1a86631f10e95">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../../_static/language_data.js" defer></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?1101f7c25c847cdc1dde4893"></script></head>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?754b77fee1b1a86631f10e95"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>

8
documentation/shaders/index.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../../_static/copybutton.css" />
<link rel="stylesheet" href="../../_static/custom.css" />
<link rel="stylesheet" href="../../_static/colors.css" />
<link rel="stylesheet" href="../../_static/styles/default.css?8fc191f9d9ad2bee5eaf543a">
<link rel="stylesheet" href="../../_static/pygments.css?8fc191f9d9ad2bee5eaf543a">
<link rel="stylesheet" href="../../_static/styles/default.css?e8df1addbeace136784351d5">
<link rel="stylesheet" href="../../_static/pygments.css?e8df1addbeace136784351d5">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../../_static/language_data.js" defer></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?8fc191f9d9ad2bee5eaf543a"></script></head>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?e8df1addbeace136784351d5"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>

8
documentation/utils/index.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../../_static/copybutton.css" />
<link rel="stylesheet" href="../../_static/custom.css" />
<link rel="stylesheet" href="../../_static/colors.css" />
<link rel="stylesheet" href="../../_static/styles/default.css?9822daa5162bf30a5ba8afbb">
<link rel="stylesheet" href="../../_static/pygments.css?9822daa5162bf30a5ba8afbb">
<link rel="stylesheet" href="../../_static/styles/default.css?524d830bcd443e39dfc3f7be">
<link rel="stylesheet" href="../../_static/pygments.css?524d830bcd443e39dfc3f7be">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../../_static/language_data.js" defer></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?9822daa5162bf30a5ba8afbb"></script></head>
<script src="../../_static/copybutton.js"></script><script src="../../_static/scripts/main.js?524d830bcd443e39dfc3f7be"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>

6
genindex.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="_static/copybutton.css" />
<link rel="stylesheet" href="_static/custom.css" />
<link rel="stylesheet" href="_static/colors.css" />
<link rel="stylesheet" href="_static/styles/default.css?895c417175c34426a7c7fe3f">
<link rel="stylesheet" href="_static/pygments.css?895c417175c34426a7c7fe3f">
<link rel="stylesheet" href="_static/styles/default.css?4c00aa05dd32a725d6d2ec1d">
<link rel="stylesheet" href="_static/pygments.css?4c00aa05dd32a725d6d2ec1d">
<style>
:root {
@ -26,7 +26,7 @@
<script src="_static/language_data.js" defer></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script><script src="_static/scripts/main.js?895c417175c34426a7c7fe3f"></script></head>
<script src="_static/copybutton.js"></script><script src="_static/scripts/main.js?4c00aa05dd32a725d6d2ec1d"></script></head>
<body dir="">
</body>

8
getting_started/config.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?de5a8dca039e1b10a01928e8">
<link rel="stylesheet" href="../_static/pygments.css?de5a8dca039e1b10a01928e8">
<link rel="stylesheet" href="../_static/styles/default.css?369b503e7dfbf3403704685b">
<link rel="stylesheet" href="../_static/pygments.css?369b503e7dfbf3403704685b">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?de5a8dca039e1b10a01928e8"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?369b503e7dfbf3403704685b"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>

56
getting_started/configuration.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?0b645e7d745443e08f3fd074">
<link rel="stylesheet" href="../_static/pygments.css?0b645e7d745443e08f3fd074">
<link rel="stylesheet" href="../_static/styles/default.css?d33dbdb85ca47da91f6ae029">
<link rel="stylesheet" href="../_static/pygments.css?d33dbdb85ca47da91f6ae029">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?0b645e7d745443e08f3fd074"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?d33dbdb85ca47da91f6ae029"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
@ -124,13 +124,15 @@
<h1>CLI flags and configuration<a class="headerlink" href="#cli-flags-and-configuration" title="Permalink to this headline"></a></h1>
<div class="section" id="command-line-interface">
<h2>Command Line Interface<a class="headerlink" href="#command-line-interface" title="Permalink to this headline"></a></h2>
<p>To run manim, you need to enter the directory at the same level as <code class="docutils literal notranslate"><span class="pre">manim.py</span></code>
<p>To run manim, you need to enter the directory at the same level as <code class="docutils literal notranslate"><span class="pre">manimlib/</span></code>
and enter the command in the following format into terminal:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python manim.py &lt;code&gt;.py &lt;Scene&gt; &lt;flags&gt;
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>manimgl &lt;code&gt;.py &lt;Scene&gt; &lt;flags&gt;
<span class="c1"># or</span>
manim-render &lt;code&gt;.py &lt;Scene&gt; &lt;flags&gt;
</pre></div>
</div>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">&lt;code&gt;.py</span></code> : The python file you wrote. Needs to be at the same level as <code class="docutils literal notranslate"><span class="pre">manim.py</span></code>, otherwise you need to use an absolute path or a relative path.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">&lt;code&gt;.py</span></code> : The python file you wrote. Needs to be at the same level as <code class="docutils literal notranslate"><span class="pre">manimlib/</span></code>, otherwise you need to use an absolute path or a relative path.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">&lt;Scene&gt;</span></code> : The scene you want to render here. If it is not written or written incorrectly, it will list all for you to choose. And if there is only one <code class="docutils literal notranslate"><span class="pre">Scene</span></code> in the file, this class will be rendered directly.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">&lt;flags&gt;</span></code> : CLI flags.</p></li>
</ul>
@ -223,31 +225,35 @@ and enter the command in the following format into terminal:</p>
<td></td>
<td><p>Show the output file in finder</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--file_name</span> <span class="pre">FILE_NAME</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--config</span></code></p></td>
<td></td>
<td><p>Guide for automatic configuration</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--file_name</span> <span class="pre">FILE_NAME</span></code></p></td>
<td></td>
<td><p>Name for the movie or image file</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--start_at_animation_number</span> <span class="pre">START_AT_ANIMATION_NUMBER</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--start_at_animation_number</span> <span class="pre">START_AT_ANIMATION_NUMBER</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">-n</span></code></p></td>
<td><p>Start rendering not from the first animation, but from another, specified by its index. If you passin two comma separated values, e.g. “3,6”, it will end the rendering at the second value.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--resolution</span> <span class="pre">RESOLUTION</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--resolution</span> <span class="pre">RESOLUTION</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">-r</span></code></p></td>
<td><p>Resolution, passed as “WxH”, e.g. “1920x1080”</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--frame_rate</span> <span class="pre">FRAME_RATE</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--frame_rate</span> <span class="pre">FRAME_RATE</span></code></p></td>
<td></td>
<td><p>Frame rate, as an integer</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--color</span> <span class="pre">COLOR</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--color</span> <span class="pre">COLOR</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">-c</span></code></p></td>
<td><p>Background color</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--leave_progress_bars</span></code></p></td>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--leave_progress_bars</span></code></p></td>
<td></td>
<td><p>Leave progress bars displayed in terminal</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--video_dir</span> <span class="pre">VIDEO_DIR</span></code></p></td>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--video_dir</span> <span class="pre">VIDEO_DIR</span></code></p></td>
<td></td>
<td><p>directory to write video</p></td>
</tr>
@ -255,28 +261,28 @@ and enter the command in the following format into terminal:</p>
</table></div>
</div>
</div>
<div class="section" id="custom-default">
<h2>custom_default<a class="headerlink" href="#custom-default" title="Permalink to this headline"></a></h2>
<div class="section" id="custom-config">
<h2>custom_config<a class="headerlink" href="#custom-config" title="Permalink to this headline"></a></h2>
<p>In order to perform more configuration (about directories, etc.) and permanently
change the default value (you don’t have to add flags to the command every time),
you can modify <code class="docutils literal notranslate"><span class="pre">custom_default.yml</span></code>. The meaning of each option is in
page <a class="reference internal" href="../documentation/custom_default.html"><span class="doc">custom_default</span></a>.</p>
<p>You can also use different <code class="docutils literal notranslate"><span class="pre">custom_default.yml</span></code> for different directories, such as
you can modify <code class="docutils literal notranslate"><span class="pre">custom_config.yml</span></code>. The meaning of each option is in
page <a class="reference internal" href="../documentation/custom_config.html"><span class="doc">custom_config</span></a>.</p>
<p>You can also use different <code class="docutils literal notranslate"><span class="pre">custom_config.yml</span></code> for different directories, such as
following the directory structure:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>manim/
├── manimlib/
│ ├── animation/
│ ├── ...
│ ├── default_config.yml
│ └── window.py
├── project/
│ ├── code.py
│ └── custom_default.yml
├── custom_default.yml
└── manim.py
│ └── custom_config.yml
└── custom_config.yml
</pre></div>
</div>
<p>When you enter the <code class="docutils literal notranslate"><span class="pre">project/</span></code> folder and run <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">../manim.py</span> <span class="pre">code.py</span> <span class="pre">&lt;Scene&gt;</span></code>,
it will overwrite <code class="docutils literal notranslate"><span class="pre">manim/custom_default.yml</span></code> with <code class="docutils literal notranslate"><span class="pre">custom_default.yml</span></code>
<p>When you enter the <code class="docutils literal notranslate"><span class="pre">project/</span></code> folder and run <code class="docutils literal notranslate"><span class="pre">manimgl</span> <span class="pre">code.py</span> <span class="pre">&lt;Scene&gt;</span></code>,
it will overwrite <code class="docutils literal notranslate"><span class="pre">manim/custom_config.yml</span></code> with <code class="docutils literal notranslate"><span class="pre">custom_config.yml</span></code>
in the <code class="docutils literal notranslate"><span class="pre">project</span></code> folder.</p>
</div>
</div>
@ -333,7 +339,7 @@ in the <code class="docutils literal notranslate"><span class="pre">project</spa
<li><a class="reference internal" href="#all-supported-flags">All supported flags</a></li>
</ul>
</li>
<li><a class="reference internal" href="#custom-default">custom_default</a></li>
<li><a class="reference internal" href="#custom-config">custom_config</a></li>
</ul>
</li>
</ul>

12
getting_started/example_scenes.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?0943760b8f2b83ffdc426719">
<link rel="stylesheet" href="../_static/pygments.css?0943760b8f2b83ffdc426719">
<link rel="stylesheet" href="../_static/styles/default.css?6f00c6efc9be691855f0d2dd">
<link rel="stylesheet" href="../_static/pygments.css?6f00c6efc9be691855f0d2dd">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?0943760b8f2b83ffdc426719"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?6f00c6efc9be691855f0d2dd"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
@ -127,7 +127,7 @@ Many example scenes are given in <code class="docutils literal notranslate"><spa
the simplest and one by one.</p>
<div class="section" id="interactivedevlopment">
<h2>InteractiveDevlopment<a class="headerlink" href="#interactivedevlopment" title="Permalink to this headline"></a></h2>
<div class="manim-example"><video autoplay="" class="manim-video" controls="" id="interactivedevlopment" loop="" src="../_static/example_scenes/InteractiveDevlopment.mp4"></video><h5 class="example-header">InteractiveDevlopment<a class="headerlink" href="#interactivedevlopment"></a></h5><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">manimlib.imports</span> <span class="kn">import</span> <span class="o">*</span>
<div class="manim-example"><video autoplay="" class="manim-video" controls="" id="interactivedevlopment" loop="" src="../_static/example_scenes/InteractiveDevlopment.mp4"></video><h5 class="example-header">InteractiveDevlopment<a class="headerlink" href="#interactivedevlopment"></a></h5><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">manimlib</span> <span class="kn">import</span> <span class="o">*</span>
<span class="k">class</span> <span class="nc">InteractiveDevlopment</span><span class="p">(</span><span class="n">Scene</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">construct</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
@ -672,7 +672,7 @@ and <code class="docutils literal notranslate"><span class="pre">TransformMatchi
<span class="c1"># be interpreted as the side towards the light, and away from</span>
<span class="c1"># the light. These can be either urls, or paths to a local file</span>
<span class="c1"># in whatever you've set as the image directory in</span>
<span class="c1"># the custom_defaults.yml file</span>
<span class="c1"># the custom_config.yml file</span>
<span class="c1"># day_texture = "EarthTextureMap"</span>
<span class="c1"># night_texture = "NightEarthTextureMap"</span>

32
getting_started/installation.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?3a7000cf3da6346237c09a7d">
<link rel="stylesheet" href="../_static/pygments.css?3a7000cf3da6346237c09a7d">
<link rel="stylesheet" href="../_static/styles/default.css?ef0fa670e28e2184c24c8e13">
<link rel="stylesheet" href="../_static/pygments.css?ef0fa670e28e2184c24c8e13">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?3a7000cf3da6346237c09a7d"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?ef0fa670e28e2184c24c8e13"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
@ -135,10 +135,12 @@
<p>If you want to hack on manimlib itself, clone this repository and in
that directory execute:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install python requirements</span>
pip install -r requirements.txt
pip install -e .
<span class="c1"># Try it out</span>
python -m manim example_scenes.py OpeningManimExample
manimgl example_scenes.py OpeningManimExample
<span class="c1"># or</span>
manim-render example_scenes.py OpeningManimExample
</pre></div>
</div>
<p>If you run the above command and no error message appears,
@ -155,8 +157,8 @@ FFmpeg</a>, and make sure that its path is in the PATH environment variable.</p>
</ol>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/3b1b/manim.git
<span class="nb">cd</span> manim
pip install -r requirements.txt
python manim.py example_scenes.py OpeningManimExample
pip install -e .
manimgl example_scenes.py OpeningManimExample
</pre></div>
</div>
</div>
@ -168,16 +170,9 @@ python manim.py example_scenes.py OpeningManimExample
</ul>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/3b1b/manim.git
<span class="nb">cd</span> manim
conda env create -f environment.yml
</pre></div>
</div>
</div>
<div class="section" id="using-virtualenv-and-virtualenvwrapper">
<h2>Using virtualenv and virtualenvwrapper<a class="headerlink" href="#using-virtualenv-and-virtualenvwrapper" title="Permalink to this headline"></a></h2>
<p>After installing <code class="docutils literal notranslate"><span class="pre">virtualenv</span></code> and <code class="docutils literal notranslate"><span class="pre">virtualenvwrapper</span></code></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/3b1b/manim.git
mkvirtualenv -a manim -r requirements.txt manim
python -m manim example_scenes.py OpeningManimExample
conda create -n manim <span class="nv">python</span><span class="o">=</span><span class="m">3</span>.8
conda activate manim
pip install -e .
</pre></div>
</div>
</div>
@ -233,7 +228,6 @@ python -m manim example_scenes.py OpeningManimExample
<li><a class="reference internal" href="#directly">Directly</a></li>
<li><a class="reference internal" href="#directly-windows">Directly (Windows)</a></li>
<li><a class="reference internal" href="#for-anaconda">For Anaconda</a></li>
<li><a class="reference internal" href="#using-virtualenv-and-virtualenvwrapper">Using virtualenv and virtualenvwrapper</a></li>
</ul>
</li>
</ul>

45
getting_started/quickstart.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?619fcc9ef56c0b82c2cda521">
<link rel="stylesheet" href="../_static/pygments.css?619fcc9ef56c0b82c2cda521">
<link rel="stylesheet" href="../_static/styles/default.css?2ce16e728d6585000415ac61">
<link rel="stylesheet" href="../_static/pygments.css?2ce16e728d6585000415ac61">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?619fcc9ef56c0b82c2cda521"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?2ce16e728d6585000415ac61"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
@ -130,9 +130,9 @@ directory structure:</p>
├── manimlib/
│ ├── animation/
│ ├── ...
│ ├── default_config.yml
│ └── window.py
├── custom_default.yml
├── manim.py
├── custom_config.yml
<span class="hll">└── start.py
</span></pre></div>
</div>
@ -145,7 +145,7 @@ directory structure:</p>
6
7
8
9</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">manimlib.imports</span> <span class="kn">import</span> <span class="o">*</span>
9</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">manimlib</span> <span class="kn">import</span> <span class="o">*</span>
<span class="k">class</span> <span class="nc">SquareToCircle</span><span class="p">(</span><span class="n">Scene</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">construct</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
@ -157,7 +157,7 @@ directory structure:</p>
</pre></div>
</td></tr></table></div></div>
<p>And run this command:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python manim.py start.py SquareToCircle
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>manimgl start.py SquareToCircle
</pre></div>
</div>
<p>A window will pop up on the screen. And then you can :</p>
@ -169,7 +169,7 @@ directory structure:</p>
</ul>
<p>Finally, you can close the window and exit the program by pressing <kbd class="kbd docutils literal notranslate">q</kbd>.</p>
<p>Run this command again:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python manim.py start.py SquareToCircle -os
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>manimgl start.py SquareToCircle -os
</pre></div>
</div>
<p>At this time, no window will pop up. When the program is finished, this rendered
@ -180,10 +180,19 @@ level directory of <code class="docutils literal notranslate"><span class="pre">
<h2>Make an image<a class="headerlink" href="#make-an-image" title="Permalink to this headline"></a></h2>
<p>Next, let’s take a detailed look at what each row does.</p>
<p><strong>Line 1</strong>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">manimlib.imports</span> <span class="kn">import</span> <span class="o">*</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span>
</pre></div>
</div>
<p>This will import all the classes that may be used when using manim.</p>
<p>&lt;&lt;&lt;&lt;&lt;&lt;&lt; HEAD</p>
<blockquote>
<div><p>from manimlib.imports import *</p>
</div></blockquote>
<hr class="docutils"/>
<blockquote>
<div><p>from manimlib import *</p>
</div></blockquote>
<p>&gt;&gt;&gt;&gt;&gt;&gt;&gt; TonyCrane-package-improve
This will import all the classes that may be used when using manim.</p>
<p><strong>Line 3</strong>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">SquareToCircle</span><span class="p">(</span><span class="n">Scene</span><span class="p">):</span>
</pre></div>
@ -232,7 +241,7 @@ how to create the mobjects in the screen and what operations need to be performe
10
11
12
13</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">manimlib.imports</span> <span class="kn">import</span> <span class="o">*</span>
13</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">manimlib</span> <span class="kn">import</span> <span class="o">*</span>
<span class="k">class</span> <span class="nc">SquareToCircle</span><span class="p">(</span><span class="n">Scene</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">construct</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
@ -248,12 +257,12 @@ how to create the mobjects in the screen and what operations need to be performe
</pre></div>
</td></tr></table></div></div>
<p>Run this command this time:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python manim.py start.py SquareToCircle
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>manimgl start.py SquareToCircle
</pre></div>
</div>
<p>The pop-up window will play animations of drawing a square and transforming
it into a circle. If you want to save this video, run:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python manim.py start.py SquareToCircle -ow
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>manimgl start.py SquareToCircle -o
</pre></div>
</div>
<p>This time there will be no pop-up window, but the video file (saved in the subdirectory
@ -290,7 +299,11 @@ at the end of the code to enable interaction:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="bp">self</span><span class="o">.</span><span class="n">embed</span><span class="p">()</span>
</pre></div>
</div>
<p>Then run <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">manim.py</span> <span class="pre">start.py</span> <span class="pre">SquareToCircle</span></code>.</p>
<p>&lt;&lt;&lt;&lt;&lt;&lt;&lt; HEAD
Then run <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">manim.py</span> <span class="pre">start.py</span> <span class="pre">SquareToCircle</span></code>.
=======
Then run <code class="docutils literal notranslate"><span class="pre">manimgl</span> <span class="pre">start.py</span> <span class="pre">SquareToCircle</span></code>.
&gt;&gt;&gt;&gt;&gt;&gt;&gt; TonyCrane-package-improve</p>
<p>After the previous animation is executed, the ipython terminal will be opened on
the command line. After that, you can continue to write code in it, and the statement
you entered will be executed immediately after pressing <kbd class="kbd docutils literal notranslate">Enter</kbd>.</p>
@ -314,7 +327,7 @@ you entered will be executed immediately after pressing <kbd class="kbd docutils
<video autoplay="" class="manim-video" controls="" loop="" src="../_static/quickstart/SquareToCircleEmbed.mp4"></video><p>If you want to enter the interactive mode directly, you don’t have to write an
empty scene containing only <code class="docutils literal notranslate"><span class="pre">self.embed()</span></code>, you can directly run the following command
(this will enter the ipython terminal while the window pops up):</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python manim.py
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>manimgl
</pre></div>
</div>
</div>

208
getting_started/structure.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?6f78e96102033e2731ec7d6b">
<link rel="stylesheet" href="../_static/pygments.css?6f78e96102033e2731ec7d6b">
<link rel="stylesheet" href="../_static/styles/default.css?fe1bfc1f8f3f3ec774e28d83">
<link rel="stylesheet" href="../_static/pygments.css?fe1bfc1f8f3f3ec774e28d83">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?6f78e96102033e2731ec7d6b"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?fe1bfc1f8f3f3ec774e28d83"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
@ -127,107 +127,105 @@
<p>The manim directory looks very complicated, with a lot of files,
but the structure is clear.</p>
<p>Below is the directory structure of manim:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>├── manim.py # Manim command entry
├── custom_default.yml # Default configuration
└── manimlib/ # manim library
├── __init__.py # run from here
├── config.py # Process CLI flags
├── constants.py # Defined some constants
├── extract_scene.py # Extract and run the scene
├── imports.py # Import all required files in manimlib
├── shader_wrapper.py # Shaders' Wrapper for convenient control
├── window.py # Playback window
├── tex_templates/ # Templates preset for LaTeX
│ ├── tex_templates.tex # Tex template (will be compiled with latex, default)
│ └── ctex_templates.tex # Tex template that support Chinese (will be compiled with xelatex)
├── camera/
│ └── camera.py # Including Camera and CameraFrame
├── scene/
│ ├── scene_file_writer.py # Used to write scene to video file
│ ├── scene.py # The basic Scene class
│ ├── three_d_scene.py # Three-dimensional scene
│ ├── graph_scene.py # GraphScene (with coordinate axis)
│ ├── reconfigurable_scene.py
│ ├── sample_space_scene.py # Probability related sample space scene
│ └── vector_space_scene.py # Vector field scene
├── animation/
│ ├── animation.py # The basic class of animation
│ ├── composition.py # Animation group
│ ├── creation.py # Animation related to Create
│ ├── fading.py # Fade related animation
│ ├── growing.py # Animation related to Grow
│ ├── indication.py # Some animations for emphasis
│ ├── movement.py # Animation related to movement
│ ├── numbers.py # Realize changes to DecimalNumber
│ ├── rotation.py # Animation related to rotation
│ ├── specialized.py # Some uncommon animations for special projects
│ ├── transform_matching_parts.py # Transform which can automatically match parts
│ ├── transform.py # Some Transforms
│ └── update.py # Realize update from function
├── mobject/
│ ├── mobject.py # The basic class of all math object
│ ├── types/ # 4 types of mobject
│ │ ├── dot_cloud.py # Dot cloud (an subclass of PMobject)
│ │ ├── image_mobject.py # Insert pictures
│ │ ├── point_cloud_mobject.py # PMobject (mobject composed of points)
│ │ ├── surface.py # ParametricSurface
│ │ └── vectorized_mobject.py # VMobject (vectorized mobject)
│ ├── svg/ # mobject related to svg
│ │ ├── svg_mobject.py # SVGMobject
│ │ ├── brace.py # Brace
│ │ ├── drawings.py # Some special mobject of svg image
│ │ ├── tex_mobject.py # Tex and TexText implemented by LaTeX
│ │ └── text_mobject.py # Text implemented by cairo
│ ├── changing.py # Dynamically changing mobject
│ ├── coordinate_systems.py # coordinate system
│ ├── frame.py # mobject related to frame
│ ├── functions.py # ParametricFunction
│ ├── geometry.py # geometry mobjects
│ ├── matrix.py # matrix
│ ├── mobject_update_utils.py # some defined updater
│ ├── number_line.py # Number line
│ ├── numbers.py # Numbers that can be changed
│ ├── probability.py # mobject related to probability
│ ├── shape_matchers.py # mobject adapted to the size of other objects
│ ├── three_dimensions.py # Three-dimensional objects
│ ├── value_tracker.py # ValueTracker which storage number
│ └── vector_field.py # VectorField
├── once_useful_constructs/ # 3b1b's Common scenes written for some videos
│ └── ...
├── shaders/ # GLSL scripts for rendering
│ ├── simple_vert.glsl # a simple glsl script for position
│ ├── insert/ # glsl scripts to be inserted in other glsl scripts
│ │ ├── NOTE.md # explain how to insert glsl scripts
│ │ └── ... # useful scripts
│ ├── image/ # glsl for images
│ │ └── ... # containing shaders for vertex and fragment
│ ├── quadratic_bezier_fill/ # glsl for the fill of quadratic bezier curve
│ │ └── ... # containing shaders for vertex, fragment and geometry
│ ├── quadratic_bezier_stroke/ # glsl for the stroke of quadratic bezier curve
│ │ └── ... # containing shaders for vertex, fragment and geometry
│ ├── surface/ # glsl for surfaces
│ │ └── ... # containing shaders for vertex and fragment
│ ├── textured_surface/ # glsl for textured_surface
│ │ └── ... # containing shaders for vertex and fragment
│ └── true_dot/ # glsl for a dot
│ └── ... # containing shaders for vertex, fragment and geometry
└── utils/ # Some useful utility functions
├── bezier.py # For bezier curve
├── color.py # For color
├── config_ops.py # Process CONFIG
├── customization.py # Read from custom_default.yml
├── debug.py # Utilities for debugging in program
├── family_ops.py # Process family members
├── file_ops.py # Process files and directories
├── images.py # Read image
├── iterables.py # Functions related to list/dictionary processing
├── paths.py # Curve path
├── rate_functions.py # Some defined rate_functions
├── simple_functions.py # Some commonly used functions
├── sounds.py # Process sounds
├── space_ops.py # Space coordinate calculation
├── strings.py # Process strings
└── tex_file_writing.py # Use LaTeX to write strings as svg
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>manimlib/ # manim library
├── __init__.py
├── __main__.py
├── default_config.yml # Default configuration file
├── config.py # Process CLI flags
├── constants.py # Defined some constants
├── extract_scene.py # Extract and run the scene
├── shader_wrapper.py # Shaders' Wrapper for convenient control
├── window.py # Playback window
├── tex_templates/ # Templates preset for LaTeX
│ ├── tex_templates.tex # Tex template (will be compiled with latex, default)
│ └── ctex_templates.tex # Tex template that support Chinese (will be compiled with xelatex)
├── camera/
│ └── camera.py # Including Camera and CameraFrame
├── scene/
│ ├── scene_file_writer.py # Used to write scene to video file
│ ├── scene.py # The basic Scene class
│ ├── three_d_scene.py # Three-dimensional scene
│ ├── sample_space_scene.py # Probability related sample space scene
│ └── vector_space_scene.py # Vector field scene
├── animation/
│ ├── animation.py # The basic class of animation
│ ├── composition.py # Animation group
│ ├── creation.py # Animation related to Create
│ ├── fading.py # Fade related animation
│ ├── growing.py # Animation related to Grow
│ ├── indication.py # Some animations for emphasis
│ ├── movement.py # Animation related to movement
│ ├── numbers.py # Realize changes to DecimalNumber
│ ├── rotation.py # Animation related to rotation
│ ├── specialized.py # Some uncommon animations for special projects
│ ├── transform_matching_parts.py # Transform which can automatically match parts
│ ├── transform.py # Some Transforms
│ └── update.py # Realize update from function
├── mobject/
│ ├── mobject.py # The basic class of all math object
│ ├── types/ # 4 types of mobject
│ │ ├── dot_cloud.py # Dot cloud (an subclass of PMobject)
│ │ ├── image_mobject.py # Insert pictures
│ │ ├── point_cloud_mobject.py # PMobject (mobject composed of points)
│ │ ├── surface.py # ParametricSurface
│ │ └── vectorized_mobject.py # VMobject (vectorized mobject)
│ ├── svg/ # mobject related to svg
│ │ ├── svg_mobject.py # SVGMobject
│ │ ├── brace.py # Brace
│ │ ├── drawings.py # Some special mobject of svg image
│ │ ├── tex_mobject.py # Tex and TexText implemented by LaTeX
│ │ └── text_mobject.py # Text implemented by cairo
│ ├── changing.py # Dynamically changing mobject
│ ├── coordinate_systems.py # coordinate system
│ ├── frame.py # mobject related to frame
│ ├── functions.py # ParametricFunction
│ ├── geometry.py # geometry mobjects
│ ├── matrix.py # matrix
│ ├── mobject_update_utils.py # some defined updater
│ ├── number_line.py # Number line
│ ├── numbers.py # Numbers that can be changed
│ ├── probability.py # mobject related to probability
│ ├── shape_matchers.py # mobject adapted to the size of other objects
│ ├── three_dimensions.py # Three-dimensional objects
│ ├── value_tracker.py # ValueTracker which storage number
│ └── vector_field.py # VectorField
├── once_useful_constructs/ # 3b1b's Common scenes written for some videos
│ └── ...
├── shaders/ # GLSL scripts for rendering
│ ├── simple_vert.glsl # a simple glsl script for position
│ ├── insert/ # glsl scripts to be inserted in other glsl scripts
│ │ ├── NOTE.md # explain how to insert glsl scripts
│ │ └── ... # useful scripts
│ ├── image/ # glsl for images
│ │ └── ... # containing shaders for vertex and fragment
│ ├── quadratic_bezier_fill/ # glsl for the fill of quadratic bezier curve
│ │ └── ... # containing shaders for vertex, fragment and geometry
│ ├── quadratic_bezier_stroke/ # glsl for the stroke of quadratic bezier curve
│ │ └── ... # containing shaders for vertex, fragment and geometry
│ ├── surface/ # glsl for surfaces
│ │ └── ... # containing shaders for vertex and fragment
│ ├── textured_surface/ # glsl for textured_surface
│ │ └── ... # containing shaders for vertex and fragment
│ └── true_dot/ # glsl for a dot
│ └── ... # containing shaders for vertex, fragment and geometry
└── utils/ # Some useful utility functions
├── bezier.py # For bezier curve
├── color.py # For color
├── config_ops.py # Process CONFIG
├── customization.py # Read from custom_config.yml
├── debug.py # Utilities for debugging in program
├── family_ops.py # Process family members
├── file_ops.py # Process files and directories
├── images.py # Read image
├── init_config.py # Configuration guide
├── iterables.py # Functions related to list/dictionary processing
├── paths.py # Curve path
├── rate_functions.py # Some defined rate_functions
├── simple_functions.py # Some commonly used functions
├── sounds.py # Process sounds
├── space_ops.py # Space coordinate calculation
├── strings.py # Process strings
└── tex_file_writing.py # Use LaTeX to write strings as svg
</pre></div>
</div>
</div>

8
getting_started/whatsnew.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="../_static/custom.css" />
<link rel="stylesheet" href="../_static/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?75c1c558743485bd0bb69b0d">
<link rel="stylesheet" href="../_static/pygments.css?75c1c558743485bd0bb69b0d">
<link rel="stylesheet" href="../_static/styles/default.css?89299132b055201f07adaa49">
<link rel="stylesheet" href="../_static/pygments.css?89299132b055201f07adaa49">
<style>
:root {
@ -26,7 +26,7 @@
<script src="../_static/language_data.js" defer></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?75c1c558743485bd0bb69b0d"></script></head>
<script src="../_static/copybutton.js"></script><script src="../_static/scripts/main.js?89299132b055201f07adaa49"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>

27
index.html
View file

@ -8,8 +8,8 @@
<link rel="stylesheet" href="_static/copybutton.css" />
<link rel="stylesheet" href="_static/custom.css" />
<link rel="stylesheet" href="_static/colors.css" />
<link rel="stylesheet" href="_static/styles/default.css?2ca5c39dc5c2c93e55816edc">
<link rel="stylesheet" href="_static/pygments.css?2ca5c39dc5c2c93e55816edc">
<link rel="stylesheet" href="_static/styles/default.css?635cf65ef300a7b8723a3bb9">
<link rel="stylesheet" href="_static/pygments.css?635cf65ef300a7b8723a3bb9">
<style>
:root {
@ -26,7 +26,7 @@
<script src="_static/language_data.js" defer></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script><script src="_static/scripts/main.js?2ca5c39dc5c2c93e55816edc"></script></head>
<script src="_static/copybutton.js"></script><script src="_static/scripts/main.js?635cf65ef300a7b8723a3bb9"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -100,7 +100,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
@ -133,7 +133,6 @@ at <a class="reference external" href="https://www.3blue1brown.com/">3Blue1Brown
<li class="toctree-l2"><a class="reference internal" href="getting_started/installation.html#directly">Directly</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/installation.html#directly-windows">Directly (Windows)</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/installation.html#for-anaconda">For Anaconda</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/installation.html#using-virtualenv-and-virtualenvwrapper">Using virtualenv and virtualenvwrapper</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="getting_started/quickstart.html">Quick Start</a><ul>
@ -145,7 +144,7 @@ at <a class="reference external" href="https://www.3blue1brown.com/">3Blue1Brown
</li>
<li class="toctree-l1"><a class="reference internal" href="getting_started/configuration.html">CLI flags and configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started/configuration.html#command-line-interface">Command Line Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/configuration.html#custom-default">custom_default</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/configuration.html#custom-config">custom_config</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="getting_started/example_scenes.html">Example Scenes</a><ul>
@ -192,14 +191,14 @@ at <a class="reference external" href="https://www.3blue1brown.com/">3Blue1Brown
<li class="toctree-l2"><a class="reference internal" href="documentation/constants.html#colours">Colours</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="documentation/custom_default.html">custom_default</a><ul>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_default.html#directories"><code class="docutils literal notranslate"><span class="pre">directories</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_default.html#tex"><code class="docutils literal notranslate"><span class="pre">tex</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_default.html#universal-import-line"><code class="docutils literal notranslate"><span class="pre">universal_import_line</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_default.html#style"><code class="docutils literal notranslate"><span class="pre">style</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_default.html#window-position"><code class="docutils literal notranslate"><span class="pre">window_position</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_default.html#break-into-partial-movies"><code class="docutils literal notranslate"><span class="pre">break_into_partial_movies</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_default.html#camera-qualities"><code class="docutils literal notranslate"><span class="pre">camera_qualities</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="documentation/custom_config.html">custom_config</a><ul>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#directories"><code class="docutils literal notranslate"><span class="pre">directories</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#tex"><code class="docutils literal notranslate"><span class="pre">tex</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#universal-import-line"><code class="docutils literal notranslate"><span class="pre">universal_import_line</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#style"><code class="docutils literal notranslate"><span class="pre">style</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#window-position"><code class="docutils literal notranslate"><span class="pre">window_position</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#break-into-partial-movies"><code class="docutils literal notranslate"><span class="pre">break_into_partial_movies</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#camera-qualities"><code class="docutils literal notranslate"><span class="pre">camera_qualities</span></code></a></li>
</ul>
</li>
</ul>

BIN
objects.inv
View file

Binary file not shown.

8
search.html
View file

@ -6,8 +6,8 @@
<link rel="shortcut icon" href="_static/icon.png"/><meta name="generator" content="sphinx-3.0.3, furo 2020.10.05.beta9"/><title>Search - manim documentation</title><link rel="stylesheet" href="_static/copybutton.css" />
<link rel="stylesheet" href="_static/custom.css" />
<link rel="stylesheet" href="_static/colors.css" />
<link rel="stylesheet" href="_static/styles/default.css?4e600ac9486e860fa4b27d15">
<link rel="stylesheet" href="_static/pygments.css?4e600ac9486e860fa4b27d15">
<link rel="stylesheet" href="_static/styles/default.css?929735bae0c7af70b5dc311c">
<link rel="stylesheet" href="_static/pygments.css?929735bae0c7af70b5dc311c">
<style>
:root {
@ -25,7 +25,7 @@
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script src="_static/searchtools.js" defer></script><script src="_static/scripts/main.js?4e600ac9486e860fa4b27d15"></script></head>
<script src="_static/searchtools.js" defer></script><script src="_static/scripts/main.js?929735bae0c7af70b5dc311c"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
@ -99,7 +99,7 @@
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="documentation/constants.html">constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="documentation/custom_default.html">custom_default</a></li>
<li class="toctree-l1"><a class="reference internal" href="documentation/custom_config.html">custom_config</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>

2
searchindex.js
View file

File diff suppressed because one or more lines are too long