Skip to content

Commit c93623b

Browse files
authored
[no-ci] docs: add uv and pixi installation instructions (#1650)
* docs: add uv and pixi installation instructions Add installation instructions for two modern Python package managers: - uv: A fast Python package and project manager from Astral, compatible with PyPI packages. Instructions cover basic install, optional deps, and virtual environment creation. - pixi: A cross-platform package manager built on the conda ecosystem, with support for conda-forge packages. Instructions cover project initialization, adding dependencies via CLI, and pixi.toml config. Both tools are increasingly popular in the scientific Python community and provide faster dependency resolution than traditional pip/conda. Closes #1248 * docs: refocus uv/pixi sections on development workflows * docs: revert cuda_bindings install.rst to upstream Remove changes to cuda_bindings/ as requested by maintainer — external contributors cannot modify files under that path. The uv/pixi dev workflow docs remain in cuda_core/. Signed-off-by: Maxime Grenu <maxime.grenu@gmail.com> --------- Signed-off-by: Maxime Grenu <maxime.grenu@gmail.com>
1 parent f9539c3 commit c93623b

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

cuda_core/docs/source/install.rst

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,56 @@ and likewise use ``cuda-version=13`` for CUDA 13.
7171
Note that to use ``cuda.core`` with nvJitLink installed from conda-forge requires ``cuda.bindings`` 12.8.0+.
7272

7373

74+
Development environment
75+
-----------------------
76+
77+
The sections above cover end-user installation. The section below focuses on
78+
a repeatable *development* workflow (editable installs and running tests).
79+
80+
Development with uv
81+
~~~~~~~~~~~~~~~~~~~
82+
83+
`uv`_ is a fast Python package and project manager. For example, to work on
84+
``cuda-core`` against CUDA 13:
85+
86+
.. code-block:: console
87+
88+
$ git clone https://github.com/NVIDIA/cuda-python
89+
$ cd cuda-python/cuda_core
90+
$ uv venv
91+
$ source .venv/bin/activate # On Windows: .venv\Scripts\activate
92+
$ uv pip install -e .[cu13] --group test
93+
94+
Run tests:
95+
96+
.. code-block:: console
97+
98+
$ python -m pytest tests
99+
100+
.. _uv: https://docs.astral.sh/uv/
101+
102+
Development with pixi
103+
~~~~~~~~~~~~~~~~~~~~~
104+
105+
`pixi`_ provides a reproducible development environment across the repository.
106+
From the repository root:
107+
108+
.. code-block:: console
109+
110+
$ git clone https://github.com/NVIDIA/cuda-python
111+
$ cd cuda-python
112+
$ pixi run -e cu13 test-core
113+
114+
To run all repository tests (pathfinder → bindings → core):
115+
116+
.. code-block:: console
117+
118+
$ pixi run -e cu13 test
119+
120+
Use ``-e cu12`` to test against CUDA 12 instead.
121+
122+
.. _pixi: https://pixi.sh/
123+
74124
Installing from Source
75125
----------------------
76126

0 commit comments

Comments
 (0)