From 4ef36a3e3122065bfd7ecbda7329ed7c7f1b94bc Mon Sep 17 00:00:00 2001 From: David Cortes Date: Wed, 14 May 2025 09:36:23 +0200 Subject: [PATCH 1/2] clarify details about conda installs --- .../beginners_guides/installation.rst | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/doc_sources/beginners_guides/installation.rst b/docs/doc_sources/beginners_guides/installation.rst index 84a7f15cb7..afb9c639a9 100644 --- a/docs/doc_sources/beginners_guides/installation.rst +++ b/docs/doc_sources/beginners_guides/installation.rst @@ -19,25 +19,26 @@ See the user guide :ref:`document ` for additional inf Installation using conda ======================== -Binary builds of :py:mod:`dpctl` are available for the `conda package manager `_ -ecosystem. +Binary builds of :py:mod:`dpctl` can be installed through the ``conda``/``mamba`` package managers, +from either the ``conda-forge`` channel, or from Intel's channel. -.. _conda_docs: https://docs.conda.io/projects/conda/en/stable/ - -Released versions of the package can be installed from the Intel channel, as -indicated by ``--channel`` option: +.. warning:: + Packages from the Intel channel are meant to be used together with dependencies from the **conda-forge** channel, and might not + work correctly when used in an environment where packages from the ``anaconda`` default channel have been installed. It is + advisable to use the `miniforge `__ installer for ``conda``/``mamba``, as it comes with + ``conda-forge`` as the only default channel. .. code-block:: bash :caption: Getting latest released version of ``dpctl`` using conda - conda create --name dpctl_env --channel https://software.repos.intel.com/python/conda/ --channel conda-forge dpctl + conda create --name dpctl_env --channel https://software.repos.intel.com/python/conda/ --channel conda-forge --override-channels dpctl -Development builds of ``dpctl`` can be accessed from the ``dppy/label/dev`` channel: +Development builds of ``dpctl`` can be installed from the ``dppy/label/dev`` channel: .. code-block:: bash :caption: Getting latest development version - conda create -n dpctl_nightly -c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge dpctl + conda create -n dpctl_nightly -c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels dpctl .. note:: If :py:mod:`dpctl` is not available for the Python version of interest, From 4288f29eff5716e811c4ab9dda32efdd0052cb49 Mon Sep 17 00:00:00 2001 From: David Cortes Date: Wed, 14 May 2025 15:04:13 +0200 Subject: [PATCH 2/2] update conda command also in readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4839a13903..a1055cc4ca 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ guide](https://www.intel.com/content/www/us/en/developer/articles/guide/installa To install `dpctl` from the Intel(R) conda channel, use the following command: ```bash -conda install dpctl -c https://software.repos.intel.com/python/conda/ -c conda-forge +conda install dpctl -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels ``` ## Pip @@ -86,7 +86,7 @@ To try out the latest features, install `dpctl` from our development channel on Anaconda cloud: ```bash -conda install dpctl -c dppy/label/dev -c conda-forge +conda install dpctl -c dppy/label/dev -c conda-forge --override-channels ``` # Building