Skip to content

Commit 8718814

Browse files
authored
Merge pull request #2080 from david-cortes-intel/conda_details
DOC: Clarify details about conda installs
2 parents 3aff6ca + 4288f29 commit 8718814

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ guide](https://www.intel.com/content/www/us/en/developer/articles/guide/installa
6767
To install `dpctl` from the Intel(R) conda channel, use the following command:
6868

6969
```bash
70-
conda install dpctl -c https://software.repos.intel.com/python/conda/ -c conda-forge
70+
conda install dpctl -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels
7171
```
7272

7373
## Pip
@@ -86,7 +86,7 @@ To try out the latest features, install `dpctl` from our
8686
development channel on Anaconda cloud:
8787

8888
```bash
89-
conda install dpctl -c dppy/label/dev -c conda-forge
89+
conda install dpctl -c dppy/label/dev -c conda-forge --override-channels
9090
```
9191

9292
# Building

docs/doc_sources/beginners_guides/installation.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,26 @@ See the user guide :ref:`document <user_guide_dpctl_license>` for additional inf
1919
Installation using conda
2020
========================
2121

22-
Binary builds of :py:mod:`dpctl` are available for the `conda package manager <conda_docs_>`_
23-
ecosystem.
22+
Binary builds of :py:mod:`dpctl` can be installed through the ``conda``/``mamba`` package managers,
23+
from either the ``conda-forge`` channel, or from Intel's channel.
2424

25-
.. _conda_docs: https://docs.conda.io/projects/conda/en/stable/
26-
27-
Released versions of the package can be installed from the Intel channel, as
28-
indicated by ``--channel`` option:
25+
.. warning::
26+
Packages from the Intel channel are meant to be used together with dependencies from the **conda-forge** channel, and might not
27+
work correctly when used in an environment where packages from the ``anaconda`` default channel have been installed. It is
28+
advisable to use the `miniforge <https://github.com/conda-forge/miniforge>`__ installer for ``conda``/``mamba``, as it comes with
29+
``conda-forge`` as the only default channel.
2930

3031
.. code-block:: bash
3132
:caption: Getting latest released version of ``dpctl`` using conda
3233
33-
conda create --name dpctl_env --channel https://software.repos.intel.com/python/conda/ --channel conda-forge dpctl
34+
conda create --name dpctl_env --channel https://software.repos.intel.com/python/conda/ --channel conda-forge --override-channels dpctl
3435
35-
Development builds of ``dpctl`` can be accessed from the ``dppy/label/dev`` channel:
36+
Development builds of ``dpctl`` can be installed from the ``dppy/label/dev`` channel:
3637

3738
.. code-block:: bash
3839
:caption: Getting latest development version
3940
40-
conda create -n dpctl_nightly -c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge dpctl
41+
conda create -n dpctl_nightly -c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels dpctl
4142
4243
.. note::
4344
If :py:mod:`dpctl` is not available for the Python version of interest,

0 commit comments

Comments
 (0)