Skip to content

DOC: Clarify details about conda installs #2446

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 3 commits into from
May 14, 2025
Merged

DOC: Clarify details about conda installs #2446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba82ebb
clarify details about conda installs
david-cortes-intel May 14, 2025
06d2794
update conda command also in readme
david-cortes-intel May 14, 2025
2ba5876
Merge branch 'master' into conda_details
antonwolfy 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 @@ -41,7 +41,7 @@ To get the library from the latest release, follow the instructions from
To install `dpnp` from the Intel(R) conda channel, use the following command:

```bash
conda install dpnp -c https://software.repos.intel.com/python/conda/ -c conda-forge
conda install dpnp -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels
```

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

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


Expand Down
14 changes: 10 additions & 4 deletions doc/quick_start_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,20 @@ Install Package from Intel(R) channel

You will need one of the commands below:

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

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

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

.. 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.

.. note::
Before installing with conda or pip it is strongly advised to update ``conda`` and ``pip`` to latest versions

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

.. code-block:: bash

conda build conda-recipe -c https://software.repos.intel.com/python/conda/ -c conda-forge
conda build conda-recipe -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels

Finally, to install the result package:

Expand All @@ -90,7 +96,7 @@ On Linux:

conda create -n build-env dpctl cython dpcpp_linux-64 mkl-devel-dpcpp tbb-devel \
onedpl-devel cmake scikit-build ninja pytest intel-gpu-ocl-icd-system \
-c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge
-c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels
conda activate build-env

On Windows:
Expand All @@ -99,7 +105,7 @@ On Windows:

conda create -n build-env dpctl cython dpcpp_win-64 mkl-devel-dpcpp tbb-devel \
onedpl-devel cmake scikit-build ninja pytest intel-gpu-ocl-icd-system \
-c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge
-c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels
conda activate build-env

To build and install the package on Linux OS, run:
Expand Down
Loading