Skip to content

Commit

Permalink
Deprecate the usage of Mambaforge -- Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hmaarrfk committed Sep 6, 2023
1 parent ee7e1d5 commit 92d3858
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@ Latest installers with PyPy 3.9 in the base environment:
| OS X | x86_64 | [Miniforge-pypy3-MacOSX-x86_64](https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge-pypy3-MacOSX-x86_64.sh) |
| Windows | x86_64 | [Miniforge-pypy3-Windows-x86_64](https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge-pypy3-Windows-x86_64.exe) |

<details><summary>Mambaforge (Deprecated as of September 2023)</summary>

In [#277](https://github.com/conda-forge/miniforge/pull/277), the functionality
of Mambaforge was incorporated into Miniforge. We have however kept the
download links of Mambaforge active to help those that have automated
workflows. Because of this, as of September 2023, the new usage of Mambaforge
is discouraged. Bug reports specific to Mambaforge will be closed as
`wont-fix`.

#### Mambaforge

Latest installers with Mamba in the base environment:
Expand All @@ -79,20 +88,22 @@ Latest installers with Mamba and PyPy in the base environment:
| OS X | x86_64 | [Mambaforge-pypy3-MacOSX-x86_64](https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-pypy3-MacOSX-x86_64.sh) |
| Windows | x86_64 | [Mambaforge-pypy3-Windows-x86_64](https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-pypy3-Windows-x86_64.exe) |

</details>

## Install

### Unix-like platforms (Mac OS & Linux)

Download the installer using curl or wget or your favorite program and run the script.
For eg:

curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh"
bash Mambaforge-$(uname)-$(uname -m).sh
curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
bash Miniforge3-$(uname)-$(uname -m).sh

or

wget "https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh"
bash Mambaforge-$(uname)-$(uname -m).sh
wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
bash Miniforge3-$(uname)-$(uname -m).sh

#### Uninstallation

Expand Down Expand Up @@ -158,17 +169,13 @@ For Linux, any architecture, use the following command
wget -O Miniforge3.sh "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
When you want to use `Mambaforge`, you should replace Miniforge into Mambaforge:
wget -O Mambaforge.sh "https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh"
For MacOSX, any architecture, use the following command
curl -fsSLo Miniforge3.sh "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-$(uname -m).sh"
This will download the appropriate installer for the present architecture with
the filename ``Miniforge3.sh`` (or ``Mambaforge.sh``). Run the shell script with the command in batch
the filename ``Miniforge3.sh``. Run the shell script with the command in batch
mode with the `-b` flash:
bash Miniforge3.sh -b -p "${HOME}/conda"
Expand All @@ -179,16 +186,13 @@ Then you should create the path to conda and activate conda.
Run this command:
source "${HOME}/conda/etc/profile.d/conda.sh"
# For mamba support also run the following command
source "${HOME}/conda/etc/profile.d/mamba.sh"
Finally, you can run the command to activate the base environment
conda activate
If you downloaded the Mambaforge installer, you should also run the following command after `source "${HOME}/conda/etc/profile.d/conda.sh`:
source "${HOME}/conda/etc/profile.d/mamba.sh"
### Homebrew
Expand Down

0 comments on commit 92d3858

Please sign in to comment.