Skip to content

Commit 5cc9d23

Browse files
Replace Miniconda with Miniforge (#727)
1 parent 71f1c91 commit 5cc9d23

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/getting-started-guide/installation.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,29 @@ Prerequisites
1212
We highly recommend visiting the `xarray tutorial`_ and `xarray documentation`_
1313
pages if you aren't familiar with ``xarray``.
1414

15-
2. xCDAT is distributed through conda, which is available through Anaconda and Miniconda.
15+
2. xCDAT is distributed on the Conda platform, which is available through Anaconda and Miniforge.
1616

17-
We recommend following the `Quick command line install`_ steps in the Anaconda docs
18-
to install Miniconda. Those steps are also provided below for convenience.
17+
We recommend following the `Quick command line install`_ steps in the Miniforge docs
18+
to install Miniforge. Those steps are also provided below for Unix-like platforms
19+
(macOS & Linux).
1920

2021
.. code-block:: bash
2122
22-
>>> # Linux
23-
>>> mkdir -p ~/miniconda3
24-
>>> curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh -o ~/miniconda3/miniconda.sh
25-
>>> bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
26-
>>> rm -rf ~/miniconda3/miniconda.sh
23+
>>> # macOS
24+
>>> curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
25+
>>> bash Miniforge3-$(uname)-$(uname -m).sh
26+
>>> rm -rf Miniforge3-$(uname)-$(uname -m).sh
2727
2828
.. code-block:: bash
2929
30-
>>> # MacOS
31-
>>> mkdir -p ~/miniconda3
32-
>>> wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh
33-
>>> bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
34-
>>> rm -rf ~/miniconda3/miniconda.sh
30+
>>> # Linux
31+
>>> wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
32+
>>> bash Miniforge3-$(uname)-$(uname -m).sh
33+
>>> rm -rf Miniforge3-$(uname)-$(uname -m).sh
3534
3635
Then follow the instructions for installation. To have conda added to
3736
your path you will need to type ``yes`` in response to ``"Do you wish the
38-
installer to initialize Miniconda3 by running conda init?"`` (we recommend
37+
installer to initialize Miniforge3 by running conda init?"`` (we recommend
3938
that you do this). Note that this will modify your shell profile (e.g.,
4039
``~/.bashrc``) to add ``conda`` to your path.
4140

@@ -47,7 +46,8 @@ Prerequisites
4746
3. Add the ``conda-forge`` channel.
4847

4948
xCDAT is hosted on the `conda-forge`_ channel, which is the standard channel for
50-
most scientific Python packages.
49+
most scientific Python packages. By default, Miniforge is pre-configured to use
50+
`conda-forge`. You can also add the channel manually by running:
5151

5252
.. code-block:: bash
5353
@@ -56,7 +56,7 @@ Prerequisites
5656
5757
.. _xarray tutorial: https://tutorial.xarray.dev/intro.html
5858
.. _xarray documentation: https://docs.xarray.dev/en/stable/getting-started-guide/index.html
59-
.. _Quick command line install: https://docs.anaconda.com/free/miniconda/#quick-command-line-install
59+
.. _Quick command line install: https://github.com/conda-forge/miniforge?tab=readme-ov-file#install
6060
.. _conda-forge: https://anaconda.org/conda-forge/xcdat
6161

6262
Instructions
@@ -66,7 +66,7 @@ Instructions
6666

6767
We recommend using the Conda environment creation procedure to install ``xcdat``.
6868
The advantage with following this approach is that Conda will attempt to resolve
69-
dependencies (e.g. ``python >= 3.9``) for compatibility.
69+
dependencies for compatibility.
7070

7171
To create an ``xcdat`` Conda environment, run:
7272

0 commit comments

Comments
 (0)