def main():
console.print(f"Manim Community [green]v{__version__}[/green]")
args = parse_args(sys.argv)
if hasattr(args, "cmd"):
if args.cmd == "cfg":
if args.subcmd:
from manim._config import cfg_subcmds
if args.subcmd == "write":
cfg_subcmds.write(args.level, args.open)
elif args.subcmd == "show":
cfg_subcmds.show()
elif args.subcmd == "export":
cfg_subcmds.export(args.dir)
else:
logger.error("No subcommand provided; Exiting...")
elif args.cmd == "plugins":
from manim.plugins import plugins_flags
if args.list:
plugins_flags.list_plugins()
elif not args.list:
logger.error("No flag provided; Exiting...")
# elif args.cmd == "some_other_cmd":
# something_else_here()
else:
config.digest_args(args)
input_file = config.get_dir("input_file")
if config["use_webgl_renderer"]:
try:
from manim.grpc.impl import frame_server_impl
server = frame_server_impl.get(input_file)
server.start()
server.wait_for_termination()
except ModuleNotFoundError as e:
print("\n\n")
print("Dependencies for the WebGL render are missing. Run "
"pip install manim[webgl_renderer] to install them.")
print(e)
print("\n\n")
else:
for SceneClass in scene_classes_from_file(input_file):
try:
scene = SceneClass()
scene.render()
open_file_if_needed(scene.renderer.file_writer)
except Exception:
print("\n\n")
traceback.print_exc()
print("\n\n")
def main():
args = parse_args(sys.argv)
if hasattr(args, "cmd"):
if args.cmd == "cfg":
if args.subcmd:
from manim._config import cfg_subcmds
if args.subcmd == "write":
cfg_subcmds.write(args.level, args.open)
elif args.subcmd == "show":
cfg_subcmds.show()
elif args.subcmd == "export":
cfg_subcmds.export(args.dir)
else:
logger.error("No subcommand provided; Exiting...")
elif args.cmd == "plugins":
from manim.plugins import plugins_flags
if args.list:
plugins_flags.list_plugins()
elif not args.list:
logger.error("No flag provided; Exiting...")
# elif args.cmd == "some_other_cmd":
# something_else_here()
else:
config.digest_args(args)
input_file = config.get_dir("input_file")
if config["use_js_renderer"]:
try:
if frame_server_impl is None:
raise ImportError(
"Dependencies for JS renderer is not installed.")
server = frame_server_impl.get(input_file)
server.start()
server.wait_for_termination()
except Exception:
print("\n\n")
traceback.print_exc()
print("\n\n")
else:
for SceneClass in scene_classes_from_file(input_file):
try:
scene = SceneClass()
scene.render()
open_file_if_needed(scene.renderer.file_writer)
except Exception:
print("\n\n")
traceback.print_exc()
print("\n\n")
def main():
args = parse_args(sys.argv)
if hasattr(args, "cmd"):
if args.cmd == "cfg":
if args.subcmd:
from manim.config import cfg_subcmds
if args.subcmd == "write":
cfg_subcmds.write(args.level, args.open)
elif args.subcmd == "show":
cfg_subcmds.show()
elif args.subcmd == "export":
cfg_subcmds.export(args.dir)
else:
logger.error("No subcommand provided; Exiting...")
# elif args.cmd == "some_other_cmd":
# something_else_here()
else:
config.digest_args(args)
module = get_module(config.get_dir("input_file"))
all_scene_classes = get_scene_classes_from_module(module)
scene_classes_to_render = get_scenes_to_render(all_scene_classes)
for SceneClass in scene_classes_to_render:
try:
if config["use_js_renderer"]:
if frame_server_impl is None:
raise ImportError(
"Dependencies for JS renderer is not installed.")
frame_server_impl.get(SceneClass).start()
else:
scene = SceneClass()
scene.render()
open_file_if_needed(scene.renderer.file_writer)
except Exception:
print("\n\n")
traceback.print_exc()
print("\n\n")
def main(**args):
class ClickArgs:
def __init__(self, args):
parser = get_streaming_configurations()
exec("self.use_ipython = {}".format(parser["CLI"]["use_ipython"]))
for name in args:
setattr(self, name, args[name])
# self.scene_names = None
def _get_kwargs(self):
return list(self.__dict__.items())
def __eq__(self, other):
if not isinstance(other, ClickArgs):
return NotImplemented
return vars(self) == vars(other)
def __contains__(self, key):
return key in self.__dict__
def __repr__(self):
return str(self.__dict__)
click_args = ClickArgs(args)
config.digest_args(click_args)
file = args["file"]
if str(file) == "-":
livestream(click_args.use_ipython)
else:
for SceneClass in scene_classes_from_file(file):
try:
scene = get_streamer(SceneClass)
play_scene(scene)
except Exception:
console.print_exception()
def manim(self, line, cell=None, local_ns=None):
r"""Render Manim scenes contained in IPython cells.
Works as a line or cell magic.
.. note::
This line and cell magic works best when used in a JupyterLab
environment: while all of the functionality is available for
classic Jupyter notebooks as well, it is possible that videos
sometimes don't update on repeated execution of the same cell
if the scene name stays the same.
This problem does not occur when using JupyterLab.
Please refer to `<https://jupyter.org/>`_ for more information about JupyterLab
and Jupyter notebooks.
Usage in line mode::
%manim MyAwesomeScene [CLI options]
Usage in cell mode::
%%manim MyAwesomeScene [CLI options]
class MyAweseomeScene(Scene):
def construct(self):
...
Run ``%manim -h`` for possible command line interface options.
"""
if cell:
exec(cell, local_ns)
cli_args = ["manim", ""] + line.split()
if len(cli_args) == 2:
# empty line.split(): no commands have been passed, call with -h
cli_args.append("-h")
try:
args = parse_args(cli_args)
except SystemExit:
return # probably manim -h was called, process ended preemptively
with tempconfig(local_ns.get("config", {})):
config.digest_args(args)
exec(f"{config['scene_names'][0]}().render()", local_ns)
local_path = Path(config["output_file"]).relative_to(
Path.cwd())
tmpfile = (Path(config["media_dir"]) / "jupyter" /
f"{_video_hash(local_path)}{local_path.suffix}")
if local_path in self.rendered_files:
self.rendered_files[local_path].unlink()
self.rendered_files[local_path] = tmpfile
os.makedirs(tmpfile.parent, exist_ok=True)
shutil.copy(local_path, tmpfile)
file_type = mimetypes.guess_type(config["output_file"])[0]
if file_type.startswith("image"):
display(Image(filename=config["output_file"]))
return
# videos need to be embedded when running in google colab
video_embed = "google.colab" in str(get_ipython())
display(
Video(
tmpfile,
html_attributes=
'controls autoplay loop style="max-width: 100%;"',
embed=video_embed,
))
def manim(
self,
line: str,
cell: str = None,
local_ns: dict[str, Any] = None,
) -> None:
r"""Render Manim scenes contained in IPython cells.
Works as a line or cell magic.
.. hint::
This line and cell magic works best when used in a JupyterLab
environment: while all of the functionality is available for
classic Jupyter notebooks as well, it is possible that videos
sometimes don't update on repeated execution of the same cell
if the scene name stays the same.
This problem does not occur when using JupyterLab.
Please refer to `<https://jupyter.org/>`_ for more information about JupyterLab
and Jupyter notebooks.
Usage in line mode::
%manim [CLI options] MyAwesomeScene
Usage in cell mode::
%%manim [CLI options] MyAwesomeScene
class MyAweseomeScene(Scene):
def construct(self):
...
Run ``%manim --help`` and ``%manim render --help`` for possible command line interface options.
.. note::
The maximal width of the rendered videos that are displayed in the notebook can be
configured via the ``media_width`` configuration option. The default is set to ``25vw``,
which is 25% of your current viewport width. To allow the output to become as large
as possible, set ``config.media_width = "100%"``.
Examples
--------
First make sure to put ``import manim``, or even ``from manim import *``
in a cell and evaluate it. Then, a typical Jupyter notebook cell for Manim
could look as follows::
%%manim -v WARNING --disable_caching -qm BannerExample
config.media_width = "75%"
class BannerExample(Scene):
def construct(self):
self.camera.background_color = "#ece6e2"
banner_large = ManimBanner(dark_theme=False).scale(0.7)
self.play(banner_large.create())
self.play(banner_large.expand())
Evaluating this cell will render and display the ``BannerExample`` scene defined in the body of the cell.
.. note::
In case you want to hide the red box containing the output progress bar, the ``progress_bar`` config
option should be set to ``None``. This can also be done by passing ``--progress_bar None`` as a
CLI flag.
"""
if cell:
exec(cell, local_ns)
args = line.split()
if not len(args) or "-h" in args or "--help" in args or "--version" in args:
main(args, standalone_mode=False, prog_name="manim")
return
modified_args = self.add_additional_args(args)
args = main(modified_args, standalone_mode=False, prog_name="manim")
with tempconfig(local_ns.get("config", {})):
config.digest_args(args)
renderer = None
if config.renderer == "opengl":
# Check if the imported mobjects extend the OpenGLMobject class
# meaning ConvertToOpenGL did its job
if "OpenGLMobject" in map(lambda cls: cls.__name__, Group.mro()):
from manim.renderer.opengl_renderer import OpenGLRenderer
renderer = OpenGLRenderer()
else:
logger.warning(
"Renderer must be set to OpenGL in the configuration file "
"before importing Manim! Using cairo renderer instead.",
)
config.renderer = "cairo"
try:
SceneClass = local_ns[config["scene_names"][0]]
scene = SceneClass(renderer=renderer)
scene.render()
finally:
# Shader cache becomes invalid as the context is destroyed
shader_program_cache.clear()
# Close OpenGL window here instead of waiting for the main thread to
# finish causing the window to stay open and freeze
if renderer is not None and renderer.window is not None:
renderer.window.close()
if config["output_file"] is None:
logger.info("No output file produced")
return
local_path = Path(config["output_file"]).relative_to(Path.cwd())
tmpfile = (
Path(config["media_dir"])
/ "jupyter"
/ f"{_generate_file_name()}{local_path.suffix}"
)
if local_path in self.rendered_files:
self.rendered_files[local_path].unlink()
self.rendered_files[local_path] = tmpfile
os.makedirs(tmpfile.parent, exist_ok=True)
shutil.copy(local_path, tmpfile)
file_type = mimetypes.guess_type(config["output_file"])[0]
if file_type.startswith("image"):
display(Image(filename=config["output_file"]))
return
# videos need to be embedded when running in google colab
video_embed = "google.colab" in str(get_ipython())
display(
Video(
tmpfile,
html_attributes=f'controls autoplay loop style="max-width: {config["media_width"]};"',
embed=video_embed,
),
)
def manim(self, line, cell=None, local_ns=None):
r"""Render Manim scenes contained in IPython cells.
Works as a line or cell magic.
.. hint::
This line and cell magic works best when used in a JupyterLab
environment: while all of the functionality is available for
classic Jupyter notebooks as well, it is possible that videos
sometimes don't update on repeated execution of the same cell
if the scene name stays the same.
This problem does not occur when using JupyterLab.
Please refer to `<https://jupyter.org/>`_ for more information about JupyterLab
and Jupyter notebooks.
Usage in line mode::
%manim [CLI options] MyAwesomeScene
Usage in cell mode::
%%manim [CLI options] MyAwesomeScene
class MyAweseomeScene(Scene):
def construct(self):
...
Run ``%manim -h`` and ``%manim render -h`` for possible command line interface options.
.. note::
The maximal width of the rendered videos that are displayed in the notebook can be
configured via the ``media_width`` configuration option. The default is set to ``25vw``,
which is 25% of your current viewport width. To allow the output to become as large
as possible, set ``config.media_width = "100%"``.
Examples
--------
First make sure to put ``import manim``, or even ``from manim import *``
in a cell and evaluate it. Then, a typical Jupyter notebook cell for Manim
could look as follows::
%%manim -v WARNING --disable_caching -qm BannerExample
config.media_width = "75%"
class BannerExample(Scene):
def construct(self):
self.camera.background_color = "#ece6e2"
banner_large = ManimBanner(dark_theme=False).scale(0.7)
self.play(banner_large.create())
self.play(banner_large.expand())
Evaluating this cell will render and display the ``BannerExample`` scene defined in the body of the cell.
.. note::
In case you want to hide the red box containing the output progress bar, the ``progress_bar`` config
option should be set to ``None``. This can also be done by passing ``--progress_bar None`` as a
CLI flag.
"""
if cell:
exec(cell, local_ns)
args = line.split()
if not len(
args
) or "-h" in args or "--help" in args or "--version" in args:
main(args, standalone_mode=False, prog_name="manim")
return
modified_args = ["--jupyter"] + args[:-1] + [""] + [args[-1]]
args = main(modified_args,
standalone_mode=False,
prog_name="manim")
with tempconfig(local_ns.get("config", {})):
config.digest_args(args)
exec(f"{config['scene_names'][0]}().render()", local_ns)
local_path = Path(config["output_file"]).relative_to(
Path.cwd())
tmpfile = (Path(config["media_dir"]) / "jupyter" /
f"{_generate_file_name()}{local_path.suffix}")
if local_path in self.rendered_files:
self.rendered_files[local_path].unlink()
self.rendered_files[local_path] = tmpfile
os.makedirs(tmpfile.parent, exist_ok=True)
shutil.copy(local_path, tmpfile)
file_type = mimetypes.guess_type(config["output_file"])[0]
if file_type.startswith("image"):
display(Image(filename=config["output_file"]))
return
# videos need to be embedded when running in google colab
video_embed = "google.colab" in str(get_ipython())
display(
Video(
tmpfile,
html_attributes=
f'controls autoplay loop style="max-width: {config["media_width"]};"',
embed=video_embed,
))
