Skip to content

Commit

Permalink
specify min conda version (#1134)
Browse files Browse the repository at this point in the history
* specify min conda version

* Apply suggestions from code review

Co-authored-by: Manolis Papadakis <[email protected]>

---------

Co-authored-by: Manolis Papadakis <[email protected]>
  • Loading branch information
bryevdv and manopapad authored Apr 23, 2024
1 parent 9ece0a3 commit 0a49a97
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 6 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,28 @@ If you have questions, please contact us at legate(at)nvidia.com.

## Installation

cuNumeric is available [on conda](https://anaconda.org/legate/cunumeric).
Create a new environment containing cuNumeric:
cuNumeric is available from [conda](https://docs.conda.io/projects/conda/en/latest/index.html)
on the [legate channel](https://anaconda.org/legate/cunumeric).
Please make sure you have at least conda version 24.1 installed, then create
a new environment containing cuNumeric:

```
mamba create -n myenv -c nvidia -c conda-forge -c legate cunumeric
conda create -n myenv -c nvidia -c conda-forge -c legate cunumeric
```

or install it into an existing environment:

```
mamba install -c nvidia -c conda-forge -c legate cunumeric
conda install -c nvidia -c conda-forge -c legate cunumeric
```

Once installed, you can verify the installation by running one of the examples
from the cuNumeric repository, for instance:

```
$ legate examples/black_scholes.py
Running black scholes on 10K options...
Elapsed Time: 129.017 ms
```

Only linux-64 packages are available at the moment.
Expand All @@ -59,7 +70,7 @@ installing on a machine without GPUs. You can force installation of a CPU-only
package by requesting it as follows:

```
mamba ... cunumeric=*=*_cpu
conda ... cunumeric=*=*_cpu
```

See the build instructions at https://nv-legate.github.io/cunumeric for details
Expand Down
21 changes: 20 additions & 1 deletion docs/cunumeric/source/user/installation.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,38 @@
Installation
============

cuNumeric is available `from conda`_:
Linux-64 packages for cuNumeric are available from
`conda <https://docs.conda.io/projects/conda/en/latest/index.html>`_
on the `legate channel <https://anaconda.org/legate/cunumeric>`_.
Please make sure you have at least conda version 24.1 installed, then create
a new environment containing cuNumeric:

.. code-block:: sh
conda install -c nvidia -c conda-forge -c legate cunumeric
Once installed, you can verify the installation by running one of the examples
from the cuNumeric repository, for instance:

.. code-block:: sh
$ legate examples/black_scholes.py
Running black scholes on 10K options...
Elapsed Time: 129.017 ms
Only linux-64 packages are available at the moment.

The default package contains GPU support, and is compatible with CUDA >= 11.4
(CUDA driver version >= r470), and Volta or later GPU architectures. There are
also CPU-only packages available, and will be automatically selected by
``conda`` when installing on a machine without GPUs.

You can force installation of a CPU-only package by requesting it as follows:

.. code-block:: sh
conda ... cunumeric=*=*_cpu
See :ref:`building cunumeric from source` for instructions on building cuNumeric manually.

.. _from conda: https://anaconda.org/legate/cunumeric

0 comments on commit 0a49a97

Please sign in to comment.