diff --git a/README.md b/README.md index cec00b052..12c033789 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 diff --git a/docs/cunumeric/source/user/installation.rst b/docs/cunumeric/source/user/installation.rst index 8c496c84f..e25e7efff 100644 --- a/docs/cunumeric/source/user/installation.rst +++ b/docs/cunumeric/source/user/installation.rst @@ -1,12 +1,25 @@ Installation ============ -cuNumeric is available `from conda`_: +Linux-64 packages for cuNumeric are available from +`conda `_ +on the `legate channel `_. +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 @@ -14,6 +27,12 @@ The default package contains GPU support, and is compatible with CUDA >= 11.4 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 \ No newline at end of file