3b1b-manim/docs/source/getting_started/installation.rst

64 lines
1.7 KiB
ReStructuredText
Raw Normal View History

2021-01-24 09:49:29 +08:00
Installation
============
Manim runs on Python 3.8.
System requirements are
- `FFmpeg <https://ffmpeg.org/>`__
- `OpenGL <https://www.opengl.org//>`__ (included in python package ``PyOpenGL``)
- `LaTeX <https://www.latex-project.org>`__ (optional, if you want to use LaTeX)
- `cairo <https://www.cairographics.org/>`_ (included in python package ``pycairo``. optional, if you want to use ``Text`` in manim)
2021-01-24 09:49:29 +08:00
Directly
--------
If you want to hack on manimlib itself, clone this repository and in
that directory execute:
.. code:: sh
# Install python requirements
pip install -r requirements.txt
# Try it out
python -m manim example_scenes.py OpeningManimExample
Directly (Windows)
------------------
1. `Install
FFmpeg <https://www.wikihow.com/Install-FFmpeg-on-Windows>`__, and make sure that its path is in the PATH environment variable.
2021-01-24 09:49:29 +08:00
2. Install a LaTeX distribution.
`TeXLive-full <http://tug.org/texlive/>`__ is recommended.
2021-01-24 09:49:29 +08:00
3. Install the remaining Python packages.
.. code:: sh
git clone https://github.com/3b1b/manim.git
cd manim
pip install -r requirements.txt
python manim.py example_scenes.py OpeningManimExample
For Anaconda
------------
2021-01-24 09:49:29 +08:00
- Install FFmpeg and LaTeX as above.
2021-01-24 09:49:29 +08:00
- Create a conda environment using
.. code-block:: sh
git clone https://github.com/3b1b/manim.git
cd manim
conda env create -f environment.yml
2021-01-24 09:49:29 +08:00
Using virtualenv and virtualenvwrapper
--------------------------------------
2021-01-24 09:49:29 +08:00
After installing ``virtualenv`` and ``virtualenvwrapper``
2021-01-24 09:49:29 +08:00
.. code:: sh
git clone https://github.com/3b1b/manim.git
mkvirtualenv -a manim -r requirements.txt manim
python -m manim example_scenes.py OpeningManimExample