2021-01-28 19:54:57 +00:00
<!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 = "Quick Start" href = "quickstart.html" / > < link rel = "prev" title = "Manim’ href = "../index.html" / >
2021-01-31 14:35:44 +00:00
< link rel = "shortcut icon" href = "../_static/icon.png" / > < meta name = "generator" content = "sphinx-3.0.3, furo 2020.10.05.beta9" / >
2021-01-28 19:54:57 +00:00
< title > Installation - manim documentation< / title >
< link rel = "stylesheet" href = "../_static/copybutton.css" / >
< link rel = "stylesheet" href = "../_static/custom.css" / >
< link rel = "stylesheet" href = "../_static/colors.css" / >
2021-02-10 21:55:33 +00:00
< link rel = "stylesheet" href = "../_static/styles/default.css?3a7000cf3da6346237c09a7d" >
< link rel = "stylesheet" href = "../_static/pygments.css?3a7000cf3da6346237c09a7d" >
2021-01-28 19:54:57 +00:00
< 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 >
2021-01-31 14:35:44 +00:00
< script src = "../_static/language_data.js" defer > < / script >
2021-01-28 19:54:57 +00:00
< script src = "../_static/clipboard.min.js" > < / script >
2021-02-10 21:55:33 +00:00
< script src = "../_static/copybutton.js" > < / script > < script src = "../_static/scripts/main.js?3a7000cf3da6346237c09a7d" > < / script > < / head >
2021-01-28 19:54:57 +00:00
< 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 class = "caption" > < 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 = "config.html" > CONFIG dictionary< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "structure.html" > Manim’ < / a > < / li >
2021-02-10 03:07:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "whatsnew.html" > What’ < / a > < / li >
2021-01-28 19:54:57 +00:00
< / ul >
< 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 >
< / ul >
< p class = "caption" > < 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 >
< div class = "section" id = "installation" >
< h1 > Installation< a class = "headerlink" href = "#installation" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Manim runs on Python 3.8.< / 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://www.cairographics.org/" > cairo< / a > (included in python package < code class = "docutils literal notranslate" > < span class = "pre" > pycairo< / span > < / code > . optional, if you want to use < code class = "docutils literal notranslate" > < span class = "pre" > Text< / span > < / code > in manim)< / p > < / li >
< / ul >
< div class = "section" id = "directly" >
< h2 > Directly< a class = "headerlink" href = "#directly" title = "Permalink to this headline" > ¶< / a > < / h2 >
< 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
< span class = "c1" > # Try it out< / span >
python -m manim example_scenes.py 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 >
< / div >
< div class = "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 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
< / pre > < / div >
< / div >
< / div >
< div class = "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 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
< / pre > < / div >
< / div >
< / div >
< / div >
< / 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 © - 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 = "#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 >
< / div >
< / div >
< / aside >
< / main >
< / div >
< / body >
< / html >
