-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove mambaforge install instructions and refer users to miniforge i…
…nstead (#1732) * Remove mambaforge install instructions and refer users to miniforge instead * Fix
- Loading branch information
1 parent
7a70c65
commit b218323
Showing
1 changed file
with
4 additions
and
192 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,195 +1,7 @@ | ||
| # Install mambaforge | ||
| # Install Mambaforge | ||
|
|
||
| This page provide detailed instructions on how to install the [mambaforge conda distribution](https://github.com/conda-forge/miniforge). | ||
| For more information on conda, mamba and its use with the robotology-superbuild, please check the [related documentation](conda-forge.md). | ||
| This page used to contain detailed documentation on how to install the `mambaforge` conda distribution. | ||
|
|
||
| ## Table of Contents | ||
| However, as of July 2024 `mambaforge` has been deprecated and all its functionalities are part of the `miniforge` distributions, and new `mambaforge` installers will not be released from January 2025. | ||
|
|
||
| * [Linux](#linux) | ||
| * [macOS](#macos) | ||
| * [Windows](#windows) | ||
|
|
||
| ## Linux | ||
|
|
||
| ### Install | ||
| First of all, download the installer and install it in its default location: | ||
| ~~~ | ||
| # Download | ||
| curl -LO https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh | ||
| # Install with default options | ||
| sh ./Mambaforge-$(uname)-$(uname -m).sh -b | ||
| ~~~ | ||
| This will install mambaforge in `~/mambaforge` . | ||
|
|
||
| To use the `conda` and `mamba` commands, you need to add the `~/mambaforge/condabin` directory to the [`PATH` environment variable](https://en.wikipedia.org/wiki/PATH_(variable)). | ||
|
|
||
| You can do this persistently by executing the following commands on the terminal: | ||
| ~~~ | ||
| ~/mambaforge/condabin/conda init | ||
| ~/mambaforge/condabin/mamba init | ||
| ~~~ | ||
|
|
||
| If you are using a non-bash shell such as `zsh`, you also need to run: | ||
| ~~~ | ||
| ~/mambaforge/condabin/conda init zsh | ||
| ~/mambaforge/condabin/mamba init zsh | ||
| ~~~ | ||
|
|
||
| By default, this command also automatically initialize the [`base` conda environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#activating-an-environment) whenever you start a terminal. | ||
| As this could interfere with other uses of your system (for example compilation against libraries installed via `apt`), it is recommended to disable this by setting: | ||
| ~~~ | ||
| conda config --set auto_activate_base false | ||
| ~~~ | ||
|
|
||
| After this configuration, whenever you open a new terminal, you should be able to access the `conda` command, but no environment should be enabled by default, i.e. if you execute `conda info` you should see: | ||
| ~~~ | ||
| $ conda info | ||
| active environment : None | ||
| shell level : 0 | ||
| [...] | ||
| ~~~ | ||
|
|
||
| To activate in any terminal the `base` environment, just run: | ||
| ~~~ | ||
| mamba activate base | ||
| ~~~ | ||
|
|
||
| ### Uninstall | ||
| To remove `mambaforge`, first cleanup your `.bashrc` either manually or by running writing following commands on the terminal: | ||
| ~~~ | ||
| ~/mambaforge/condabin/conda init --reverse | ||
| ~/mambaforge/condabin/mamba init --reverse | ||
| ~~~ | ||
|
|
||
| If you are using a non-bash shell such as `zsh` you need to modify the appropriate file, either manually or by running the commands: | ||
| ~~~ | ||
| ~/mambaforge/condabin/conda init zsh --reverse | ||
| ~/mambaforge/condabin/mamba init zsh --reverse | ||
| ~~~ | ||
|
|
||
| Then, just remove the `~/mambaforge` directory and the setting files: | ||
| ~~~ | ||
| rm -rf ~/mambaforge | ||
| rm -rf ~/.conda | ||
| rm -rf ~/.condarc | ||
| ~~~ | ||
|
|
||
|
|
||
| ## macOS | ||
|
|
||
| ### Install | ||
| First of all, download the installer and install it in its default location: | ||
| ~~~ | ||
| # Download | ||
| curl -fsSLo Mambaforge.sh https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-MacOSX-$(uname -m).sh | ||
| # Install with default options | ||
| sh ./Mambaforge.sh -b | ||
| ~~~ | ||
| This will install mambaforge in `~/mambaforge` . | ||
|
|
||
| To use the `conda` command, you need to add the `~/mambaforge/condabin` directory to the [`PATH` environment variable](https://en.wikipedia.org/wiki/PATH_(variable)). | ||
|
|
||
| You can do this persistently by writing the following commands on the terminal: | ||
| ~~~ | ||
| ~/mambaforge/condabin/conda init | ||
| ~/mambaforge/condabin/mamba init | ||
| ~~~ | ||
|
|
||
| If you are using a non-bash shell such as `zsh`, you also need to run: | ||
| ~~~ | ||
| ~/mambaforge/condabin/conda init zsh | ||
| ~/mambaforge/condabin/mamba init zsh | ||
| ~~~ | ||
|
|
||
| By default, this command also automatically initialize the [`base` conda environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#activating-an-environment) whenever you start a terminal. | ||
| As this could interfere with other uses of your system (for example compilation against libraries installed via `apt`), it is recommended to disable this by setting: | ||
| ~~~ | ||
| conda config --set auto_activate_base false | ||
| ~~~ | ||
|
|
||
| After this configuration, whenever you open a new terminal, you should be able to access the `conda` command, but no environment should be enabled by default, i.e. if you execute `conda info` you should see: | ||
| ~~~ | ||
| $ conda info | ||
| active environment : None | ||
| shell level : 0 | ||
| [...] | ||
| ~~~ | ||
|
|
||
| To activate in any terminal the `base` environment, just run: | ||
| ~~~ | ||
| mamba activate base | ||
| ~~~ | ||
|
|
||
| ### Uninstall | ||
| To remove `mambaforge`, first cleanup your `PATH` environment variable by writing the following commands on the terminal: | ||
| ~~~ | ||
| ~/mambaforge/condabin/conda init --reverse | ||
| ~/mambaforge/condabin/mamba init --reverse | ||
| ~~~ | ||
|
|
||
| If you are using a non-bash shell such as `zsh` you need to modify the appropriate file, either manually or by writing the following commands on the terminal: | ||
| ~~~ | ||
| ~/mambaforge/condabin/conda init zsh --reverse | ||
| ~/mambaforge/condabin/mamba init zsh --reverse | ||
| ~~~ | ||
|
|
||
|
|
||
| Then, just remove the `~/mambaforge` directory and the setting files: | ||
| ~~~ | ||
| rm -rf ~/mambaforge | ||
| rm -rf ~/.conda | ||
| rm -rf ~/.condarc | ||
| ~~~ | ||
|
|
||
| ## Windows | ||
|
|
||
| **For all the following instructions, we strongly suggest to use Command Prompt as shell on Windows. If you want to use Powershell, not all the mentioned feature may work, see [conda-powershell-troubleshooting documentation page](conda-powershell-troubleshooting.md) for more info.** | ||
|
|
||
| First of all, download the installer from https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-Windows-x86_64.exe and install it by double clicking on it. | ||
|
|
||
| If you already have a Python that you use in your system, make sure that you deselect the "Register Mambaforge Python as my default Python" during the installation. | ||
|
|
||
| After the installation has been completed, Mambaforge should have been installed in `%HOMEDRIVE%%HOMEPATH%\AppData\Local\mambaforge`. | ||
|
|
||
| If you explicitly selected the for All Users install, Mambaforge will be installed in `%ProgramData%\mambaforge`, in that case substitute `%HOMEDRIVE%%HOMEPATH%\AppData\Local\mambaforge` with `%ProgramData%\mambaforge` in the rest of the documentation. In this case you should also have admin rights (or run the console as administrator) otherwise you will get an error ("ERROR during elevated execution"). | ||
|
|
||
| To ensure that the `conda` binary can be used in your terminal, open a Command Prompt and run: | ||
| ~~~ | ||
| %HOMEDRIVE%%HOMEPATH%\AppData\Local\mambaforge\condabin\conda init | ||
| %HOMEDRIVE%%HOMEPATH%\AppData\Local\mambaforge\condabin\mamba init | ||
| ~~~ | ||
|
|
||
| By default, this command also automatically initialize the [`base` conda environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#activating-an-environment) whenever you start a terminal. | ||
| As this could interfere with other uses of your system (for example compilation against libraries installed not installed via `conda`), it is recommended to disable this by setting: | ||
| ~~~ | ||
| %HOMEDRIVE%%HOMEPATH%\AppData\Local\mambaforge\condabin\conda config --set auto_activate_base false | ||
| ~~~ | ||
|
|
||
| After this configuration, whenever you open a new terminal, you should be able to access the `conda` command, but no environment should be enabled by default, i.e. if you execute `conda info` you should see: | ||
| ~~~ | ||
| > conda info | ||
| active environment : None | ||
| shell level : 0 | ||
| [...] | ||
| ~~~ | ||
|
|
||
| To activate in any terminal the `base` environment, just run: | ||
| ~~~ | ||
| mamba activate base | ||
| ~~~ | ||
|
|
||
| ### Uninstall | ||
| First of all, open a command prompt and run: | ||
| ~~~ | ||
| %HOMEDRIVE%%HOMEPATH%\AppData\Local\mambaforge\condabin\conda init --reverse | ||
| %HOMEDRIVE%%HOMEPATH%\AppData\Local\mambaforge\condabin\mamba init --reverse | ||
| ~~~ | ||
|
|
||
| Then go to "Add or remove programs", search for Mambaforge and uninstall it. | ||
|
|
||
| After that, delete the `%HOMEDRIVE%%HOMEPATH%/.conda` directory and the `%HOMEDRIVE%%HOMEPATH%/.condarc` file. | ||
|
|
||
| ⚠️ On Windows, in case you forgot to follow the previous steps and now your Command Prompt is broken, you can try the following script in PowerShell as described in https://github.com/conda-forge/miniforge/issues/164#issuecomment-1092812732: | ||
| ``` | ||
| C:\Windows\System32\reg.exe DELETE "HKCU\Software\Microsoft\Command Processor" /v AutoRun /f` | ||
| ``` | ||
| For this reason, please install `miniforge`, referring to the instructions in [`install-miniforge.md`](./install-miniforge.md) page. |