Skip to content

Commit 69e3a42

Browse files
authored
Update installation.rst with Windows/HIP instructions (#2207)
Discussed on #2203
1 parent 58fb44f commit 69e3a42

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/installation.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,38 @@ In most cases, it is better to install `WSL
191191
the Linux instructions above. The C code generated by the Futhark
192192
compiler should work on Windows, except for the ``multicore`` backend.
193193

194+
Alternatively, you can use the C compiler that is installed with
195+
`w64devkit`_
196+
197+
Using HIP
198+
~~~~~~~~~~~~~~~~~~~~
199+
200+
*Note*: dependencies can sometimes move faster than this documentation.
201+
This Windows/HIP HowTo was written in Jan 2025 on a setup without WSL,
202+
using PowerShell, and after the installation of `w64devkit`_ via `scoop`_.
203+
204+
If you wish to use ``futhark hip`` on windows, you must have the
205+
`ROCm/HIP SDK`_ installed on your system.
206+
The SDK installation will create a ``HIP_PATH`` environment variable on
207+
your system pointing to the installed SDK. It is advised to check that
208+
this variable has indeed been created.
209+
210+
In order for ```futhark hip``` to work you need to setup 3 environment
211+
variables in your PowerShell::
212+
213+
# CPATH creation so that the compiler can find the HIP headers
214+
$env:CPATH = $env:HIP_PATH + "include"
215+
# LIBRARY_PATH creation so that the linker can find the HIP libraries
216+
$env:LIBRARY_PATH = $env:HIP_PATH + "lib"
217+
# PATH modification so that the compiled app can find the HIP DLLs at runtime
218+
$env:PATH = $env:PATH + ";" + $env:HIP_PATH + "bin"
219+
220+
221+
.. _`ROCm/HIP SDK`: https://www.amd.com/fr/developer/resources/rocm-hub/hip-sdk.html
222+
.. _`w64devkit`: https://github.com/skeeto/w64devkit
223+
.. _`scoop` : https://scoop.sh/
224+
225+
194226
Futhark with Nix
195227
----------------
196228

0 commit comments

Comments
 (0)