Update usage docs

PTsolvers · Nov 6, 2023 · eab0977 · eab0977
1 parent d591b6a
commit eab0977
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/docs/src/usage.md b/docs/src/usage.md
@@ -1,3 +1,29 @@
 # Library
 
 ## Running tests
+
+### CPU tests
+
+To run the FastIce test suite on the CPU, simple run `test` from within the package mode or using `Pkg`:
+```julia-repl
+using Pkg
+Pkg.test("FastIce")
+```
+
+### GPU tests
+
+To run the FastIce test suite on CUDA or ROC Backend (Nvidia or AMD GPUs), respectively, run the tests using `Pkg` adding following `test_args`:
+
+#### For CUDA backend (Nvidia GPU):
+
+```julia-repl
+using Pkg
+Pkg.test("FastIce"; test_args=["--backend=CUDA"])
+```
+
+#### For ROC backend (AMD GPU):
+
+```julia-repl
+using Pkg
+Pkg.test("FastIce"; test_args=["--backend=AMDGPU"])
+```