folkslinux
/
mamba
mirror of https://github.com/mamba-org/mamba.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve install instructions (#2908)

This commit is contained in:
Jonas Haag 2023-10-18 11:49:41 +03:00 committed by GitHub
parent da60313e85
commit d0922122c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/source/mamba-installation.rst
View File

@ -7,16 +7,16 @@ Mamba Installation
Fresh install (recommended)
***************************
We recommend that you start with the `Mambaforge distribution <https://github.com/conda-forge/miniforge#mambaforge>`_.
Mambaforge comes with the popular ``conda-forge`` channel preconfigured, but you can modify the configuration to use any channel you like.
Note that Anaconda channels are generally incompatible with conda-forge, so you should not mix them.
We recommend that you start with the `Miniforge distribution <https://github.com/conda-forge/miniforge>`_ >= `Miniforge3-22.3.1-0`.
If you need an older version of Mamba, please use the Mambaforge distribution.
Miniforge comes with the popular ``conda-forge`` channel preconfigured, but you can modify the configuration to use any channel you like.
After successful installation, you can use the mamba commands as described in :ref:`mamba user guide<mamba>`.
.. note::
For both ``mamba`` and ``conda``, the ``base`` environment is meant to hold their dependencies.
It is strongly discouraged to install anything else in the base envionment.
Doing so may break ``mamba`` and ``conda`` installation.
1. After installation, please :ref`make sure <defaults_channels>` that you do not have the Anaconda default channels configured.
2. Do not install anything into the `base` environment as this might break your installation. See :ref:`here <base_packages>` for details.
Existing ``conda`` install (not recommended)
@ -24,13 +24,13 @@ Existing ``conda`` install (not recommended)
.. warning::
This way of installing Mamba is **not recommended**.
We strongly recommend to use the Mambaforge method (see above).
We strongly recommend to use the Miniforge method (see above).
To get ``mamba``, just install it *into the base environment* from the ``conda-forge`` channel:
.. code:: bash
# NOT RECOMMENDED: This method of installation is not recommended, prefer Mambaforge instead (see above)
# NOT RECOMMENDED: This method of installation is not recommended, prefer Miniforge instead (see above)
# conda install -n base --override-channels -c conda-forge mamba 'python_abi=*=*cp*'
@ -41,10 +41,10 @@ To get ``mamba``, just install it *into the base environment* from the ``conda-f
Docker images
*************
In addition to the Mambaforge standalone distribution (see above), there are also the
`condaforge/mambaforge <https://hub.docker.com/r/condaforge/mambaforge>`_ docker
In addition to the Miniforge standalone distribution (see above), there are also the
`condaforge/miniforge3 <https://hub.docker.com/r/condaforge/miniforge3>`_ docker
images:
.. code-block:: bash
docker run -it --rm condaforge/mambaforge:latest mamba info
docker run -it --rm condaforge/miniforge3:latest mamba info

16
docs/source/user_guide/troubleshooting.rst
View File

@ -13,6 +13,8 @@ Mamba should be installed to the ``base`` environment
Installing Mamba to an environment other than ``base`` is not supported. Mamba must be installed in the ``base`` environment alongside Conda, and no other packages may be installed into ``base``.
.. _base_packages:
No other packages should be installed to ``base``
-------------------------------------------------
@ -32,9 +34,18 @@ It is **not recommended** to use the `Anaconda default channels <https://docs.an
Please note that we won't be able to help resolving any problems you might face with the Anaconda channels.
Please use ``conda-forge`` instead.
To check if you have any Anaconda default channels in your configuration, use::
Please disable the default channels in your install command::
$ mamba info
...
channel URLs : https://repo.anaconda.com/pkgs/... # BAD!
...
https://conda.anaconda.org/conda-forge/...
...
Please change your configuration to use only ``conda-forge`` using one of the following methods.
Disable the default channels in your install command::
mamba create --override-channels ...
@ -54,6 +65,7 @@ Or in your :file:`~/.condarc` file:
...
channels:
- ...
- defaults # BAD! Remove this if it exists.
- nodefaults
Mixing the ``defaults`` and ``conda-forge`` channels