Skip to content

Commit 83d81f5

Browse files
author
Release Manager
committed
sagemathgh-37588: Update Conda installation instructions to use Miniforge
<!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> Based on the discussion in https://groups.google.com/g/sage- devel/c/GaQHdu0Q6UU and sagemath#37184, we now follow the offical recommendation and use Miniforge over the soft- deprecated Mambaforge. Since we are exclusively testing on miniforge, this change also aligns the docs with the ci. Moreover, I've removed the recommendation to install mamba (using `conda install mamba`) which is not recommended according to the [offical docs](https://mamba.readthedocs.io/en/latest/installation/mamba- installation.html#existing-conda-install-not-recommended). ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#37588 Reported by: Tobias Diez Reviewer(s): Matthias Köppe, roed314, William Stein
2 parents 685e86b + 40de356 commit 83d81f5

File tree

3 files changed

+34
-27
lines changed

3 files changed

+34
-27
lines changed

build/pkgs/configure/checksums.ini

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
tarball=configure-VERSION.tar.gz
2-
sha1=facd0b123855a68d836680b22177058ac3333aad
3-
md5=180414ef1a73c5cc12a657abb5affb63
4-
cksum=101476296
2+
sha1=ecd112699d45a08acc904081495200200aa5375d
3+
md5=15351e13c37ab18a3dca25db30f45e33
4+
cksum=1274317165
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
5c45eed9e45a60223067282bb70cdb805d66eeff
1+
86e1c3569bfb8b90061cf3aa01801677d0b9cc9e

src/doc/en/installation/conda.rst

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,27 @@ SageMath can be installed on Linux and macOS via Conda from the
99
Both the ``x86_64`` (Intel) architecture and the ``arm64``/``aarch64``
1010
architectures (including Apple Silicon, M1) are supported.
1111

12-
You will need a working Conda installation: either Mambaforge/Miniforge,
12+
You will need a working Conda installation: either Miniforge (or Mambaforge),
1313
Miniconda or Anaconda. If you don't have one yet, we recommend installing
14-
`Mambaforge <https://github.com/conda-forge/miniforge#mambaforge>`_ as
14+
`Miniforge <https://github.com/conda-forge/miniforge>`_ as
1515
follows. In a terminal,
1616

1717
.. code-block:: shell
1818
19-
$ curl -L -O https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh
20-
$ sh Mambaforge-$(uname)-$(uname -m).sh
19+
$ curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
20+
$ bash Miniforge3-$(uname)-$(uname -m).sh
2121
22-
* Mambaforge and Miniforge use conda-forge as the default channel.
22+
* Miniforge (and Mambaforge) use conda-forge as the default channel.
2323

2424
* If you are using Miniconda or Anaconda, set it up to use conda-forge:
2525

2626
* Add the conda-forge channel: ``conda config --add channels conda-forge``
2727

2828
* Change channel priority to strict: ``conda config --set channel_priority strict``
2929

30-
Optionally, use `mamba <https://github.com/mamba-org/mamba>`_,
30+
If you installed Miniforge (or Mambaforge), we recommend to use
31+
`mamba <https://mamba.readthedocs.io/en/latest/index.html>`_ in the following,
3132
which uses a faster dependency solver than ``conda``.
32-
If you installed Mambaforge, it is already provided. Otherwise, use
33-
34-
.. code-block:: shell
35-
36-
$ conda install mamba
37-
3833

3934
.. _sec-installation-conda-binary:
4035

@@ -43,10 +38,17 @@ Installing all of SageMath from conda (not for development)
4338

4439
Create a new conda environment containing SageMath, either with ``mamba`` or ``conda``:
4540

46-
.. code-block:: shell
41+
.. tab:: mamba
42+
43+
.. code-block:: shell
4744
48-
$ mamba create -n sage sage python=X # either
49-
$ conda create -n sage sage python=X # or
45+
$ mamba create -n sage sage python=X
46+
47+
.. tab:: conda
48+
49+
.. code-block:: shell
50+
51+
$ conda create -n sage sage python=X
5052
5153
where ``X`` is version of Python, e.g. ``3.9``.
5254

@@ -109,17 +111,22 @@ Here we assume that you are using a git checkout.
109111

110112
$ export SAGE_NUM_THREADS=24
111113

112-
- As a recommended step, install the ``mamba`` package manager. If
113-
you skip this step, replace ``mamba`` by ``conda`` in the
114-
following steps::
115-
116-
$ conda install mamba
117-
118114
- Create and activate a new conda environment with the dependencies of Sage
119115
and a few additional developer tools::
120116

121-
$ mamba env create --file src/environment-dev-3.11-linux.yml --name sage-dev
122-
$ conda activate sage-dev
117+
.. tab:: mamba
118+
119+
.. code-block:: shell
120+
121+
$ mamba env create --file src/environment-dev-3.11-linux.yml --name sage-dev
122+
$ conda activate sage-dev
123+
124+
.. tab:: conda
125+
126+
.. code-block:: shell
127+
128+
$ conda env create --file src/environment-dev-3.11-linux.yml --name sage-dev
129+
$ conda activate sage-dev
123130

124131
Alternatively, you can use ``src/environment-3.11-linux.yml`` or
125132
``src/environment-optional-3.11-linux.yml``, which will only install standard

0 commit comments

Comments
 (0)