Skip to content

Commit

Permalink
Split macOS and Linux commands for installing Miniforge
Browse files Browse the repository at this point in the history
  • Loading branch information
tomvothecoder committed Jan 28, 2025
1 parent ab23588 commit 3be0df3
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/getting-started-guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,22 @@ Prerequisites
We highly recommend visiting the `xarray tutorial`_ and `xarray documentation`_
pages if you aren't familiar with ``xarray``.

2. xCDAT is distributed through conda, which is available through Anaconda and Miniforge.
2. xCDAT is distributed on the Conda platform, which is available through Anaconda and Miniforge.

We recommend following the `Quick command line install`_ steps in the Miniforge docs
to install Miniforge. Those steps are also provided below for Unix-like platforms
(macOS & Linux).

.. code-block:: bash
>>> # macOS
>>> curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
>>> bash Miniforge3-$(uname)-$(uname -m).sh
>>> rm -rf Miniforge3-$(uname)-$(uname -m).sh
.. code-block:: bash
>>> # Linux
>>> wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
>>> bash Miniforge3-$(uname)-$(uname -m).sh
>>> rm -rf Miniforge3-$(uname)-$(uname -m).sh
Expand All @@ -38,8 +46,8 @@ Prerequisites
3. Add the ``conda-forge`` channel.

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

.. code-block:: bash
Expand Down

0 comments on commit 3be0df3

Please sign in to comment.