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
3b1b-manim/getting_started/installation.html
3b1b d3dd12566d Deploying to gh-pages from @ 9ba684d35f 🚀
2024-01-01 20:56:19 +00:00

277 lines
No EOL
13 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/><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="Quick Start" href="quickstart.html" /><link rel="prev" title="Manim’s documentation" href="../index.html" />
<link rel="shortcut icon" href="../_static/icon.png"/><meta name="generator" content="sphinx-3.0.3, furo 2020.10.05.beta9"/>
<title>Installation - manim documentation</title>
<link rel="stylesheet" href="../_static/copybutton.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/manim-kindergarten/CDN@master/manimgl_assets/custom.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/manim-kindergarten/CDN@master/manimgl_assets/colors.css" />
<link rel="stylesheet" href="../_static/styles/default.css?df490c9fc5acaea8aac7fd06">
<link rel="stylesheet" href="../_static/pygments.css?df490c9fc5acaea8aac7fd06">
<style>
:root {
--color-code-background: #f8f8f8;
--color-code-foreground: #000000;
}
</style>
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script><script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js" defer></script>
<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?df490c9fc5acaea8aac7fd06"></script></head>
<body dir="">
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
stroke-width="1.5" stroke="#101010" stroke-linecap="round" stroke-linejoin="round">
<path stroke="none" d="M0 0h24v24H0z"/>
<line x1="4" y1="6" x2="20" y2="6" />
<line x1="10" y1="12" x2="20" y2="12" />
<line x1="6" y1="18" x2="20" y2="18" />
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
class="feather feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
class="feather feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></label>
<div class="page">
<header class="mobile-header">
<label class="header-left nav-overlay-icon" for="__navigation">
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
<div class="header-center"><div class="brand">manim documentation</div></div>
<div class="header-right"></div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="../index.html">
<div class="sidebar-logo-container">
<img class="sidebar-logo" src="../_static/transparent_graph.png" alt="Logo"/>
</div>
</a><form class="sidebar-search-container" method="get" action="../search.html">
<input class="sidebar-search" placeholder="Search" name="q">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form><div class="sidebar-tree sidebar-scroll">
<p><span class="caption-text">Getting Started</span></p>
<ul class="current">
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">CLI flags and configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="example_scenes.html">Example Scenes</a></li>
<li class="toctree-l1"><a class="reference internal" href="structure.html">Manim’s structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="whatsnew.html">What’s new</a></li>
</ul>
<p><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_config.html">custom_config</a></li>
</ul>
<p><span class="caption-text">Development</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../development/changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../development/contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../development/about.html">About</a></li>
</ul>
</div>
</div>
</div>
</aside>
<main class="main">
<div class="content">
<article role="main">
<label class="toc-overlay-icon" for="__toc">
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
<section id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<p>Manim runs on Python 3.7 or higher.</p>
<p>System requirements are：</p>
<ul class="simple">
<li><p><a class="reference external" href="https://ffmpeg.org/">FFmpeg</a></p></li>
<li><p><a class="reference external" href="https://www.opengl.org//">OpenGL</a> (included in python package <code class="docutils literal notranslate"><span class="pre">PyOpenGL</span></code>)</p></li>
<li><p><a class="reference external" href="https://www.latex-project.org">LaTeX</a> (optional, if you want to use LaTeX)</p></li>
<li><p><a class="reference external" href="https://pango.org">Pango</a> (only for Linux)</p></li>
</ul>
<section id="install-ffmpeg">
<h2>Install FFmpeg<a class="headerlink" href="#install-ffmpeg" title="Permalink to this headline"></a></h2>
</section>
<section id="install-ffmpeg-windows">
<h2>Install FFmpeg Windows<a class="headerlink" href="#install-ffmpeg-windows" title="Permalink to this headline"></a></h2>
<div class="highlight-cmd notranslate"><div class="highlight"><pre><span></span>choco install ffmpeg
</pre></div>
</div>
</section>
<section id="install-ffmepeg-linux">
<h2># Install FFmepeg Linux<a class="headerlink" href="#install-ffmepeg-linux" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>update
$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>ffmpeg
$<span class="w"> </span>ffmpeg<span class="w"> </span>-version
</pre></div>
</div>
</section>
<section id="install-ffmpeg-macos">
<h2># Install FFmpeg MacOS<a class="headerlink" href="#install-ffmpeg-macos" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Download This ZIP file <a href="#system-message-1"><span class="problematic" id="problematic-1">`</span></a><a class="reference external" href="https://www.gyan.dev/ffmpeg/builds/ffmpeg-git-full">https://www.gyan.dev/ffmpeg/builds/ffmpeg-git-full</a>.7z`(if the link is not working download this zip file from there original website)</p></li>
</ul>
</section>
<section id="directly">
<h2>Directly<a class="headerlink" href="#directly" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install manimgl</span>
pip<span class="w"> </span>install<span class="w"> </span>manimgl
<span class="c1"># Try it out</span>
manimgl
</pre></div>
</div>
<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<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
<span class="c1"># Try it out</span>
manimgl<span class="w"> </span>example_scenes.py<span class="w"> </span>OpeningManimExample
<span class="c1"># or</span>
manim-render<span class="w"> </span>example_scenes.py<span class="w"> </span>OpeningManimExample
</pre></div>
</div>
<p>If you run the above command and no error message appears,
then you have successfully installed all the environments required by manim.</p>
</section>
<section id="directly-windows">
<h2>Directly (Windows)<a class="headerlink" href="#directly-windows" title="Permalink to this headline"></a></h2>
<ol class="arabic simple">
<li><p><a class="reference external" href="https://www.wikihow.com/Install-FFmpeg-on-Windows">Install
FFmpeg</a>, and make sure that its path is in the PATH environment variable.</p></li>
<li><p>Install a LaTeX distribution.
<a class="reference external" href="http://tug.org/texlive/">TeXLive-full</a> is recommended.</p></li>
<li><p>Install the remaining Python packages.</p></li>
</ol>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/3b1b/manim.git
<span class="nb">cd</span><span class="w"> </span>manim
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
manimgl<span class="w"> </span>example_scenes.py<span class="w"> </span>OpeningManimExample
</pre></div>
</div>
</section>
<section id="for-anaconda">
<h2>For Anaconda<a class="headerlink" href="#for-anaconda" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Install FFmpeg and LaTeX as above.</p></li>
<li><p>Create a conda environment using</p></li>
</ul>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/3b1b/manim.git
<span class="nb">cd</span><span class="w"> </span>manim
conda<span class="w"> </span>create<span class="w"> </span>-n<span class="w"> </span>manim<span class="w"> </span><span class="nv">python</span><span class="o">=</span><span class="m">3</span>.8
conda<span class="w"> </span>activate<span class="w"> </span>manim
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
</pre></div>
</div>
</section>
</section>
</article>
<footer>
<div class="related-pages">
<a class="next-page" href="quickstart.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Quick Start</div>
</div>
<svg><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="../index.html">
<svg><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Home</div>
</div>
</a>
</div>
<div class="related-information">
<span class="copyright">Copyright &copy; - This document has been placed in the public domain.</span> |
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
Contents
</span>
</div>
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Installation</a><ul>
<li><a class="reference internal" href="#install-ffmpeg">Install FFmpeg</a></li>
<li><a class="reference internal" href="#install-ffmpeg-windows">Install FFmpeg Windows</a></li>
<li><a class="reference internal" href="#install-ffmepeg-linux"># Install FFmepeg Linux</a></li>
<li><a class="reference internal" href="#install-ffmpeg-macos"># Install FFmpeg MacOS</a></li>
<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>
</ul>
</li>
</ul>
</div>
</div>
</aside>
</main>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink