mirror of
https://github.com/jeertmans/manim-slides.git
synced 2025-05-29 20:57:27 +08:00
be227bbdea
* chore(deps): use PDM instead of Poetry * chore(git): move to top * chore(lint): fixes * fix(pdm): dynamic version did not work * chore(ci): fix syntax for Windows * fix(ci): typo * wip(docs): updates * chore(docs): add changelog entry * chore(docs): admonitions * chore(docs): update to use manim-slides render * chore(docs): make it better
105 lines
3.1 KiB
Markdown
105 lines
3.1 KiB
Markdown
# Installation
|
|
|
|
While installing Manim Slides and its dependencies on your global Python is fine,
|
|
we recommend using a virtual environment
|
|
(e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.
|
|
|
|
Therefore, the following documentation will install Manim Slides using
|
|
[pipx](https://pipx.pypa.io/). This tool is a drop-in replacement
|
|
for installing Python packages that ship with one or more executable.
|
|
|
|
The benefit of using pipx is that it will automatically create a new virtual
|
|
environment for every package you install.
|
|
|
|
:::{note}
|
|
Everytime you read `pipx install`, you can use `pip install` instead,
|
|
if you are working in a virtual environment or else.
|
|
:::
|
|
|
|
## Dependencies
|
|
|
|
Manim Slides requires either Manim or ManimGL to be installed, along
|
|
with their dependencies.
|
|
Having both packages installed is fine too.
|
|
|
|
If none of those packages are installed,
|
|
please refer to their specific installation guidelines:
|
|
- [Manim](https://docs.manim.community/en/stable/installation.html)
|
|
- [ManimGL](https://3b1b.github.io/manim/getting_started/installation.html)
|
|
|
|
:::{warning}
|
|
If you install Manim from its git repository, as suggested by ManimGL,
|
|
make sure to first check out a supported version (e.g., `git checkout tags/v1.6.1`
|
|
for ManimGL), otherwise it might install an unsupported version of Manim!
|
|
See [#314](https://github.com/jeertmans/manim-slides/issues/314).
|
|
:::
|
|
|
|
## Pip Install
|
|
|
|
The recommended way to install the latest release is to use pip:
|
|
|
|
```bash
|
|
pipx install -U manim-slides
|
|
```
|
|
|
|
:::{tip}
|
|
While not necessary, the `-U` indicates that we would
|
|
like to upgrade to the latest version available,
|
|
if Manim Slides is already installed.
|
|
:::
|
|
|
|
Optionally, you can also install Manim or ManimGL using extras[^1]:
|
|
|
|
```bash
|
|
pipx install -U "manim-slides[manim]" # For Manim
|
|
# or
|
|
pipx install -U "manim-slides[manimgl]" # For ManimGL
|
|
```
|
|
|
|
You can check that Manim Slides was correctly installed with:
|
|
|
|
```bash
|
|
manim-slides --version
|
|
```
|
|
|
|
:::{warning}
|
|
If you are installing with pipx, this is mandatory to at least include
|
|
either `manim` or `manimgl`.
|
|
:::
|
|
|
|
[^1]: You still need to have Manim or ManimGL platform-specific dependencies
|
|
installed on your computer.
|
|
|
|
## Optional Dependencies
|
|
|
|
Along with the optional dependencies for Manim and ManimGL,
|
|
Manim Slides offers additional *extras*, that can be activated
|
|
using optional dependencies:
|
|
|
|
- `magic`, to include a Jupyter magic to render
|
|
animations inside notebooks. This automatically installs `manim`,
|
|
and does not work with ManimGL;
|
|
- `manim` and `manimgl`, for installing the corresponding
|
|
dependencies;
|
|
- `sphinx-directive`, to generate presentation inside your Sphinx
|
|
documentation. This automatically installs `manim`,
|
|
and does not work with ManimGL;
|
|
|
|
Installing those extras can be done with the following syntax:
|
|
|
|
```bash
|
|
pipx install -U "manim-slides[extra1,extra2]"
|
|
```
|
|
|
|
:::{note}
|
|
The quotes `"` are added because not all shell support unquoted
|
|
brackets (e.g., zsh) or commas (e.g., Windows).
|
|
:::
|
|
|
|
## Install From Repository
|
|
|
|
An alternative way to install Manim Slides is to clone the git repository,
|
|
and install from there: read the
|
|
[contributing guide](./contributing/workflow)
|
|
to know how to process.
|