Skip to content

Commit 61672ca

Browse files
DOC: Clarify details about conda installs (#2446)
Clarify details about conda installs
1 parent ed06b34 commit 61672ca

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To get the library from the latest release, follow the instructions from
4141
To install `dpnp` from the Intel(R) conda channel, use the following command:
4242

4343
```bash
44-
conda install dpnp -c https://software.repos.intel.com/python/conda/ -c conda-forge
44+
conda install dpnp -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels
4545
```
4646

4747
## Pip
@@ -60,7 +60,7 @@ To try out the latest features, install `dpnp` using our development channel on
6060
Anaconda cloud:
6161

6262
```bash
63-
conda install dpnp -c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge
63+
conda install dpnp -c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels
6464
```
6565

6666

doc/quick_start_guide.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,20 @@ Install Package from Intel(R) channel
4242

4343
You will need one of the commands below:
4444

45-
* Conda: ``conda install dpnp -c https://software.repos.intel.com/python/conda/ -c conda-forge``
45+
* Conda: ``conda install dpnp -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels``
4646

4747
* Pip: ``python -m pip install --index-url https://software.repos.intel.com/python/pypi dpnp``
4848

4949
These commands install dpnp package along with its dependencies, including
5050
``dpctl`` package with `Data Parallel Control Library`_ and all required
5151
compiler runtimes and OneMKL.
5252

53+
.. warning::
54+
Packages from the Intel channel are meant to be used together with dependencies from the **conda-forge** channel, and might not
55+
work correctly when used in an environment where packages from the ``anaconda`` default channel have been installed. It is
56+
advisable to use the `miniforge <https://github.com/conda-forge/miniforge>`__ installer for ``conda``/``mamba``, as it comes with
57+
``conda-forge`` as the only default channel.
58+
5359
.. note::
5460
Before installing with conda or pip it is strongly advised to update ``conda`` and ``pip`` to latest versions
5561

@@ -68,7 +74,7 @@ And to build dpnp package from the sources:
6874

6975
.. code-block:: bash
7076
71-
conda build conda-recipe -c https://software.repos.intel.com/python/conda/ -c conda-forge
77+
conda build conda-recipe -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels
7278
7379
Finally, to install the result package:
7480

@@ -90,7 +96,7 @@ On Linux:
9096
9197
conda create -n build-env dpctl cython dpcpp_linux-64 mkl-devel-dpcpp tbb-devel \
9298
onedpl-devel cmake scikit-build ninja pytest intel-gpu-ocl-icd-system \
93-
-c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge
99+
-c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels
94100
conda activate build-env
95101
96102
On Windows:
@@ -99,7 +105,7 @@ On Windows:
99105
100106
conda create -n build-env dpctl cython dpcpp_win-64 mkl-devel-dpcpp tbb-devel \
101107
onedpl-devel cmake scikit-build ninja pytest intel-gpu-ocl-icd-system \
102-
-c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge
108+
-c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels
103109
conda activate build-env
104110
105111
To build and install the package on Linux OS, run:

0 commit comments

Comments
 (0)