Skip to content

DOC: Clarify details about conda installs #2080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 14, 2025
Merged

DOC: Clarify details about conda installs #2080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ef36a3
clarify details about conda installs
david-cortes-intel May 14, 2025
4288f29
update conda command also in readme
david-cortes-intel May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
19 changes: 10 additions & 9 deletions docs/doc_sources/beginners_guides/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,26 @@ See the user guide :ref:`document <user_guide_dpctl_license>` for additional inf
Installation using conda
========================

Binary builds of :py:mod:`dpctl` are available for the `conda package manager <conda_docs_>`_
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 <https://github.com/conda-forge/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,
Expand Down
Loading