From d07352c6483ac920415a796bd20dea25a71c526a Mon Sep 17 00:00:00 2001 From: Pavel Zwerschke Date: Sat, 6 Apr 2024 22:31:35 +0200 Subject: [PATCH 1/4] Mention pixi in installation guide --- docs/source/installation.rst | 9 +++++---- docs/source/installation/conda.rst | 13 ++++++++----- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 7e91a63c30..d42d9d41f3 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -28,10 +28,10 @@ your system's Python, or via Docker). .. _conda-installation: -Installing Manim in conda -************************* +Installing Manim in conda or pixi +********************************* -Conda is a package manager for Python that allows creating environments +Conda and pixi are package managers for Python that allows creating environments where all your dependencies are stored. Like this, you don't clutter up your PC with unwanted libraries and you can just delete the environment when you don't need it anymore. It is a good way to install manim since all dependencies like @@ -54,7 +54,8 @@ Installing Manim locally ************************ Manim is a Python library, and it can be -`installed via pip `__. However, +installed via `pip `__ +or `conda `__. However, in order for Manim to work properly, some additional system dependencies need to be installed first. The following pages have operating system specific instructions for you to follow. diff --git a/docs/source/installation/conda.rst b/docs/source/installation/conda.rst index b946b003a0..4b5e66b0bb 100644 --- a/docs/source/installation/conda.rst +++ b/docs/source/installation/conda.rst @@ -4,18 +4,21 @@ Conda Required Dependencies --------------------- -To create a conda environment, you must first install -`conda `__ -or `mamba `__, -the two most popular conda clients. +There are several package managers that work with conda packages, +namely `conda `__, +`mamba `__ and `pixi `__. -After installing conda, you can create a new environment and install ``manim`` inside by running +After installing your package manager, you can create a new environment and install ``manim`` inside by running .. code-block:: bash + # using conda conda create -n my-manim-environment conda activate my-manim-environment conda install -c conda-forge manim + # using pixi + pixi init + pixi add manim Since all dependencies (except LaTeX) are handled by conda, you don't need to worry about needing to install additional dependencies. From a866356aab3ac2cb009a78a6d3498460ca9c8c65 Mon Sep 17 00:00:00 2001 From: Pavel Zwerschke Date: Mon, 8 Apr 2024 18:32:55 +0200 Subject: [PATCH 2/4] Update docs/source/installation/conda.rst Co-authored-by: adeshpande <110117391+JasonGrace2282@users.noreply.github.com> --- docs/source/installation/conda.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/installation/conda.rst b/docs/source/installation/conda.rst index 4b5e66b0bb..b69c8d6de6 100644 --- a/docs/source/installation/conda.rst +++ b/docs/source/installation/conda.rst @@ -12,7 +12,7 @@ After installing your package manager, you can create a new environment and inst .. code-block:: bash - # using conda + # using conda or mamba conda create -n my-manim-environment conda activate my-manim-environment conda install -c conda-forge manim From 974e67414ba8f95e08ae9b90faccb4b0a48ffd3d Mon Sep 17 00:00:00 2001 From: Pavel Zwerschke Date: Tue, 9 Apr 2024 14:52:48 +0200 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Benjamin Hackl --- docs/source/installation.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index d42d9d41f3..1c12f7d939 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -28,10 +28,10 @@ your system's Python, or via Docker). .. _conda-installation: -Installing Manim in conda or pixi -********************************* +Installing Manim via Conda and related environment managers +*********************************************************** -Conda and pixi are package managers for Python that allows creating environments +Conda is a package manager for Python that allows creating environments where all your dependencies are stored. Like this, you don't clutter up your PC with unwanted libraries and you can just delete the environment when you don't need it anymore. It is a good way to install manim since all dependencies like From c21e012023c441c8646111517a3f3af43e641c5b Mon Sep 17 00:00:00 2001 From: Pavel Zwerschke Date: Tue, 9 Apr 2024 14:54:14 +0200 Subject: [PATCH 4/4] Add note --- docs/source/installation.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 1c12f7d939..9822e3e17a 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -39,6 +39,15 @@ It is a good way to install manim since all dependencies like Also, the installation steps are the same, no matter if you are on Windows, Linux, Intel Macs or on Apple Silicon. +.. NOTE:: + + There are various popular alternatives to Conda like + `mamba `__ / + `micromamba `__, + or `pixi `__. + They all can be used to setup a suitable, isolated environment + for your Manim projects. + The following pages show how to install Manim in a conda environment: .. toctree::