Skip to content

Commit

Permalink
Update docs to suggest Miniforge3 (#274)
Browse files Browse the repository at this point in the history
Due to licensing restrictions, suggest users install Miniforge3 from now on.

Authors:
  - Peter Andreas Entschev (https://github.com/pentschev)

Approvers:
  - Lawrence Mitchell (https://github.com/wence-)

URL: #274
  • Loading branch information
pentschev authored Aug 29, 2024
1 parent 0563c25 commit 18ada55
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,27 @@ UCXX is an object-oriented C++ interface for UCX, with native support for Python

### Environment setup

Before starting it is necessary to have the necessary dependencies installed. The simplest way to get started is to installed [Miniconda](https://docs.conda.io/en/latest/miniconda.html) and then to create and activate an environment with the provided development file:
Before starting it is necessary to have the necessary dependencies installed. The simplest way to get started is to install [Miniforge](https://github.com/conda-forge/miniforge) and then to create and activate an environment with the provided development file, for CUDA 11.x:

```
$ conda env create -n ucxx -f conda/environments/all_cuda-118_arch-x86_64.yaml
```

Or for CUDA 12.x:

```
$ conda env create -n ucxx -f conda/environments/all_cuda-125_arch-x86_64.yaml
```

And then activate the newly created environment:

```
$ conda activate ucxx
```

#### Faster conda dependency resolution

The procedure aforementioned should complete without issues, but it may be slower than necessary. One alternative to speed up dependency resolution is to install [mamba](https://mamba.readthedocs.io/en/latest/) before creating the new environment. After installing Miniconda, mamba can be installed with:
The procedure aforementioned should complete without issues, but it may be slower than necessary. One alternative to speed up dependency resolution is to install [mamba](https://mamba.readthedocs.io/en/latest/) before creating the new environment. After installing Miniforge, mamba can be installed with:

```
$ conda install -c conda-forge mamba
Expand Down

0 comments on commit 18ada55

Please sign in to comment.