Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention pixi in installation guide #3678

Merged
merged 8 commits into from
Apr 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ your system's Python, or via Docker).

.. _conda-installation:

Installing Manim in conda
*************************
Installing Manim via Conda and related environment managers
***********************************************************

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
Expand All @@ -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 <https://mamba.readthedocs.io/en/latest/>`__ /
`micromamba <https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html>`__,
or `pixi <https://pixi.sh>`__.
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::
Expand All @@ -54,7 +63,8 @@ Installing Manim locally
************************

Manim is a Python library, and it can be
`installed via pip <https://pypi.org/project/manim/>`__. However,
installed via `pip <https://pypi.org/project/manim/>`__
or `conda <https://anaconda.org/conda-forge/manim/>`__. 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.
Expand Down
13 changes: 8 additions & 5 deletions docs/source/installation/conda.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,21 @@ Conda
Required Dependencies
---------------------

To create a conda environment, you must first install
`conda <https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html>`__
or `mamba <https://mamba.readthedocs.io/en/latest/installation.html>`__,
the two most popular conda clients.
There are several package managers that work with conda packages,
namely `conda <https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html>`__,
`mamba <https://mamba.readthedocs.io>`__ and `pixi <https://pixi.sh>`__.

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 or mamba
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.
Expand Down
Loading