From edd294af2758fbd53c4da2635c9f413e26ebdd8f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ludovic=20R=C3=A4ss?=
 <61313342+luraess@users.noreply.github.com>
Date: Thu, 8 Feb 2024 18:17:58 +0100
Subject: [PATCH] Add meta (#1)

This PR adds CI, docs, license file, and testing infrastructure.
---
 .buildkite/pipeline.yml             |  15 ++++++
 .buildkite/run_tests.yml            |  56 +++++++++++++++++++++
 .codecov.yml                        |  10 ++++
 .github/dependabot.yml              |   7 +++
 .github/workflows/CompatHelper.yml  |  16 ++++++
 .github/workflows/Documentation.yml |  26 ++++++++++
 .github/workflows/TagBot.yml        |  18 +++++++
 .github/workflows/UnitTests.yml     |  68 +++++++++++++++++++++++++
 .gitignore                          |   7 +++
 LICENSE                             |  21 ++++++++
 Project.toml                        |   2 +-
 README.md                           |  14 ++++++
 docs/.gitignore                     |   2 +
 docs/Project.toml                   |   5 ++
 docs/make.jl                        |  26 ++++++++++
 docs/src/assets/logo.png            | Bin 0 -> 4443 bytes
 docs/src/index.md                   |   5 ++
 docs/src/lib/modules.md             |  50 +++++++++++++++++++
 docs/src/usage/runtests.md          |  27 ++++++++++
 ext/ChmyAMDGPUExt/ChmyAMDGPUExt.jl  |  10 ++++
 ext/ChmyCUDAExt/ChmyCUDAExt.jl      |  10 ++++
 test/Project.toml                   |  13 +++++
 test/common.jl                      |  15 ++++++
 test/runtests.jl                    |  74 ++++++++++++++++++++++++++++
 test/test_fields.jl                 |  54 ++++++++++++++++++++
 25 files changed, 550 insertions(+), 1 deletion(-)
 create mode 100644 .buildkite/pipeline.yml
 create mode 100644 .buildkite/run_tests.yml
 create mode 100644 .codecov.yml
 create mode 100644 .github/dependabot.yml
 create mode 100644 .github/workflows/CompatHelper.yml
 create mode 100644 .github/workflows/Documentation.yml
 create mode 100644 .github/workflows/TagBot.yml
 create mode 100644 .github/workflows/UnitTests.yml
 create mode 100644 LICENSE
 create mode 100644 README.md
 create mode 100644 docs/.gitignore
 create mode 100644 docs/Project.toml
 create mode 100644 docs/make.jl
 create mode 100644 docs/src/assets/logo.png
 create mode 100644 docs/src/index.md
 create mode 100644 docs/src/lib/modules.md
 create mode 100644 docs/src/usage/runtests.md
 create mode 100644 test/Project.toml
 create mode 100644 test/common.jl
 create mode 100644 test/test_fields.jl

diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
new file mode 100644
index 00000000..5a74e483
--- /dev/null
+++ b/.buildkite/pipeline.yml
@@ -0,0 +1,15 @@
+# see: https://github.com/staticfloat/forerunner-buildkite-plugin
+steps:
+  - label: ":runner: Dynamically launch Pipelines"
+    plugins:
+      - staticfloat/forerunner:
+          watch:
+            - ".buildkite/run_tests.yml"
+            - ".buildkite/pipeline.yml"
+            - "**/*.toml"
+            - "src/**"
+            - "ext/**"
+            - "test/**"
+          target: ".buildkite/run_tests.yml"
+    agents:
+      queue: "juliagpu"
diff --git a/.buildkite/run_tests.yml b/.buildkite/run_tests.yml
new file mode 100644
index 00000000..390bc152
--- /dev/null
+++ b/.buildkite/run_tests.yml
@@ -0,0 +1,56 @@
+steps:
+  - label: "CUDA Julia {{matrix.version}}"
+    matrix:
+      setup:
+        version:
+          - "1.9"
+          - "1.10"
+    plugins:
+      - JuliaCI/julia#v1:
+          version: "{{matrix.version}}"
+      - JuliaCI/julia-coverage#v1:
+          codecov: true
+    command: |
+      julia -e 'println("--- :julia: Instantiating project")
+                using Pkg
+                Pkg.develop(; path=pwd())' || exit 3
+
+      julia -e 'println("+++ :julia: Running tests")
+                using Pkg
+                Pkg.test("Chmy"; test_args=["--backend=CUDA"], coverage=true)'
+    agents:
+      queue: "juliagpu"
+      cuda: "*"
+    timeout_in_minutes: 120
+    soft_fail:
+      - exit_status: 3
+
+  - label: "AMDGPU Julia {{matrix.version}}"
+    matrix:
+      setup:
+        version:
+          - "1.10"
+    plugins:
+      - JuliaCI/julia#v1:
+          version: "{{matrix.version}}"
+      - JuliaCI/julia-coverage#v1:
+          codecov: true
+    command: |
+      julia -e 'println("--- :julia: Instantiating project")
+                using Pkg
+                Pkg.develop(; path=pwd())' || exit 3
+
+      julia -e 'println("+++ :julia: Running tests")
+                using Pkg
+                Pkg.test("Chmy"; test_args=["--backend=AMDGPU"], coverage=true)'
+    agents:
+      queue: "juliagpu"
+      rocm: "*"
+      rocmgpu: "gfx1101" # select Ludovic's Navi 3 card (ROCm 6.0)
+    timeout_in_minutes: 120
+    soft_fail:
+      - exit_status: 3
+    env:
+      JULIA_NUM_THREADS: 4
+env:
+  SECRET_CODECOV_TOKEN: "D2H/GglFTcK7SKyfuO/Fy34xrVWHzXbtGTGQXAA3wpEPNAATGhHO/mIm0ILLzhMZSI1LplJBxJ7nV5WVsky0e/01nbSnW5iB0QqFHK8rD+lXUr4ls4zMlyUa0Lvsl/HixFyhwBtFhy8ruwUsqN8AbJNSJSiF9x4jXhzTgIvlO25/HqQObcfJa6qwcw0m9uMa3K26w1xrPhdE7F4mdUUREjB1W8dzfkKF+vZUeMqYFKgit21uQ9QsRjDJl0ExOEw0SC910rtGHtDO0bpIe+D1nEGQsQr8VEN3o0hOCgTJrya8MFitBqkKeVBV/NUImu4UtxlNb7r0ZrjTawiFle2tfg==;U2FsdGVkX1+sdgrm8OBTX9elIdJMwLMpOvXFFtHrG9lj5J8qDBdbjJDva3XMXkbF6I4PCh9G9NW0pEcF9ghb7g=="
diff --git a/.codecov.yml b/.codecov.yml
new file mode 100644
index 00000000..6aa5b2cd
--- /dev/null
+++ b/.codecov.yml
@@ -0,0 +1,10 @@
+coverage:
+  status:
+    patch:
+      default:
+        informational: true
+    project:
+      default:
+        informational: true
+    changes: false
+comment: false
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 00000000..d60f0707
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,7 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "monthly"
diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml
new file mode 100644
index 00000000..992cf229
--- /dev/null
+++ b/.github/workflows/CompatHelper.yml
@@ -0,0 +1,16 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia -e 'using CompatHelper; CompatHelper.main()'
\ No newline at end of file
diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
new file mode 100644
index 00000000..8c62080f
--- /dev/null
+++ b/.github/workflows/Documentation.yml
@@ -0,0 +1,26 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - lr/doc-ci # update to match your development branch (master, main, dev, trunk, ...)
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.10'
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
+        run: julia --project=docs/ docs/make.jl
diff --git a/.github/workflows/TagBot.yml b/.github/workflows/TagBot.yml
new file mode 100644
index 00000000..74e8da8a
--- /dev/null
+++ b/.github/workflows/TagBot.yml
@@ -0,0 +1,18 @@
+name: TagBot
+
+on:
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+
+jobs:
+  TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
+          draft: true
\ No newline at end of file
diff --git a/.github/workflows/UnitTests.yml b/.github/workflows/UnitTests.yml
new file mode 100644
index 00000000..54951fac
--- /dev/null
+++ b/.github/workflows/UnitTests.yml
@@ -0,0 +1,68 @@
+name: Unit Tests
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '.github/workflows/UnitTests.yml'
+      - '**/*.toml'
+      - 'src/**'
+      - 'ext/**'
+      - 'test/**'
+  pull_request:
+    paths:
+      - '.github/workflows/UnitTests.yml'
+      - '**/*.toml'
+      - 'src/**'
+      - 'ext/**'
+      - 'test/**'
+env:
+  JULIA_NUM_THREADS: 2
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.9'
+          - '1'   # Latest stable 1.x release of Julia
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+        arch:
+          - x64
+        include:
+          - os: macos-14
+            arch: "aarch64"
+            version: "1"
+        # include:
+        #   - version: 'nightly'
+        #     os: ubuntu-latest
+        #     arch: x64
+        #     allow_failure: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v4
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@latest
+      - uses: julia-actions/julia-runtest@latest
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false  # or true if you want CI to fail when Codecov fails
diff --git a/.gitignore b/.gitignore
index ba39cc53..cff04407 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,8 @@
+docs/build/
+docs/site/
+
 Manifest.toml
+LocalPreferences.toml
+
+.DS_Store
+.vscode
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 00000000..5b022522
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Pseudo-Transient solvers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Project.toml b/Project.toml
index 6166e0bc..99b4d1c6 100644
--- a/Project.toml
+++ b/Project.toml
@@ -1,6 +1,6 @@
 name = "Chmy"
 uuid = "33a72cf0-4690-46d7-b987-06506c2248b9"
-authors = ["Ivan Utkin <iutkin@ethz.ch>"]
+authors = ["Ivan Utkin <iutkin@ethz.ch>, Ludovic Raess <ludovic.rass@gmail.com>, and contributors"]
 version = "0.1.0"
 
 [deps]
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..5c3f0ee2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+<h1> <img src="docs/src/assets/logo.png" alt="Chmy.jl" width="30"> Chmy.jl </h1>
+
+[![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://PTsolvers.github.io/Chmy.jl/dev)
+[![CPU CI](https://github.com/PTsolvers/Chmy.jl/actions/workflows/UnitTests.yml/badge.svg)](https://github.com/PTsolvers/Chmy.jl/actions/workflows/UnitTests.yml)
+[![GPU CI](https://badge.buildkite.com/3cfbc1f4a0553ce2281925dec2bceba9446bb429286621ec92.svg)](https://buildkite.com/julialang/chmy-dot-jl)
+[![codecov](https://codecov.io/gh/PTsolvers/Chmy.jl/graph/badge.svg?token=GMQZHJD807)](https://codecov.io/gh/PTsolvers/Chmy.jl)
+
+Hey, that's Chmy.jl 🚀
+
+## Documentation
+Checkout the [documentation](https://PTsolvers.github.io/Chmy.jl/dev) for API reference and usage.
+
+## Funding
+The development of this package is supported by the [GPU4GEO](https://ptsolvers.github.io/GPU4GEO/) [PASC](https://www.pasc-ch.org) project.
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 00000000..a303fff2
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,2 @@
+build/
+site/
diff --git a/docs/Project.toml b/docs/Project.toml
new file mode 100644
index 00000000..1814eb33
--- /dev/null
+++ b/docs/Project.toml
@@ -0,0 +1,5 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+
+[compat]
+Documenter = "1"
diff --git a/docs/make.jl b/docs/make.jl
new file mode 100644
index 00000000..25b3e966
--- /dev/null
+++ b/docs/make.jl
@@ -0,0 +1,26 @@
+using Documenter
+using Chmy
+
+push!(LOAD_PATH,"../src/")
+
+makedocs(
+    sitename = "Chmy",
+    authors="Ivan Utkin, Ludovic Räss and contributors",
+    format = Documenter.HTML(
+        prettyurls=get(ENV, "CI", nothing) == "true", # easier local build
+        ansicolor=true
+        ),
+    modules = [Chmy],
+    warnonly = [:missing_docs],
+    pages = Any[
+        "Home" => "index.md",
+        "Usage" => Any["usage/runtests.md"],
+        "Library" => Any["lib/modules.md"]
+    ]
+)
+
+deploydocs(
+    repo = "github.com/PTsolvers/Chmy.jl.git",
+    devbranch = "lr/doc-ci",
+    push_preview = true
+)
diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..a5048ba64f57f06105865c7bc1833924285287ae
GIT binary patch
literal 4443
zcmd^DX;f2L628c^0bFRbl_(nQHi$DSpeUdiB8ZLYXs{QXW|5=;#RUzr7!8C(0U4D=
zUt0D>v_V@9$|g(5qKs$`V4~3=LI{j3K_F2~2n0grW={W`bEbdUKW2X1_fA#ay7f-g
zS5>#(g?%Ky1y;+g000XJyM4a{z)Wvi7IPs-y(E(WUzX9k17iW0x5%{2UdWSX0I*p=
z@b&)Tbm5p>Knl_ETl(CuBqUY{>#uMAY_HY2XtT9FW$PA;5QqFRX;9Vn6(jZXo{X~H
z+4Gld2<C&oht!t}9rpKHWj4$y30rD;@|^MEUBy4S#eT~lUs!+I;VZ8hSz8!?`hDL{
zCuxf`vV*;TO`aM9gf~~lXC*sk+4BT#)-&>5I~A!05;CAV`S#HrKxxWkkH%*eT{>?p
z*eUp+=}bfj<yT6$Pc1+%wFuiu*mP!m^7-?+MAp59hCHESI@{j@B(gb)JKqb8`GO{>
zffZ40&H!Z>4=ae@FdIgWyRIgE@FbjIv~B{u-|>i5GY(<}(@kUNU$Wtl{u~fDn+u~0
zBbHAm`y0yqLmO?+0QB7kY{G#%;`kHFT^KM|U0rGHBI@L^<0yD?y%h;*Gs<HphKiK5
zuf{?2{<eekC9}@6i}b34)1e2fK|m`<z}2e!b5va7gg{$o3F;%<#k1cPW%+B^p*I1@
zIUX}XPQpL;Y&YMrOi=PpT&#55TmEmpK27bFI2o<~vD)v$HwoZYudZv1<ge*Dx)i+2
zZLJv-kQ>P-+&%-jsRO=Bvun2puu~_-@x}z4$XF|%1KNa4MoB+gO*aQ2ftM7Hc~ssU
zkbB`wDT>uNC}!a4p!XeDCLNmEGStMtfb^F!h<&7iptmygu%BeD!7-cwx=FR+U?hf~
zqcXeZ0`(rHV1U(PI#|00+WYj3(V!7Cj^TalqeR409==f&BJ~C#F9}F8){}6m$ID~;
zQO}#4=jZwJX0RgO10r;7EFozWW7PNMq;jzA%DK#6a#YO8gFkPOmQ46!uJIEH3mesj
z8?KEK8d(`|@&bmkXAo&x9zN=~L~oxISkFGvZ-%}ZaA4lo;hRg<#cV~?c5~K*8+T3m
zqr*NW!}HW36)1|66q0Lw6o&r6R2nF3bkF|Yuog;jF#fW&Z(On^&UFylz3b~RlC;W{
zq)IISb0fbvjwULpH6}s&^#$RUIFOD=%y<0kV+~Rv@x>Yq*q8gi%y|8i5Ay{bfMnN;
zZs`sh6bA)dJZ>Cr{>ewsVPaQz(0ACkEYi2j%mKO(KJ_jaB?3nD>0kOgWS#(>PUgD(
z;(k#=!#sdaq@<Ty-mo-uq0&$Uw;(mR){s$QdBY`N;wXYVHa3_;1Cq8MJI*~v?^m+>
z$C8_CvBncTb5@UmdrWvM-AO|jpLp2Uj9o{_45pe<1~b`r;}p|=Lng>IF{0~pB4*Rb
zOJztmp{g*Vq7Mt4#DsF4NNtjJp86*E#sb4{DkiHPI|acuh5a}t1JRb5EiohAIcSDb
z{BHJ%$I<QPz^Q$0$qf{%^7BubH205jP?zs^<3skuIEuoMk&K~eezK~vdOD_$F|rYm
zeUx@V4b1xN2&Dh(E{DWYdoGi2VqA@=f?ICMSFpsf!~C;Xr_(;J(^>0~ri)L>`*q07
zgBWA<3%Z5yrUgUX*s4KIy^VYNY9eA_w(ro04H&Y~W8$wUh?_c2Tjh)tzc%0LpfS8j
ze;N=^g*%#MtAW=V4Q{x&mG_E{a@`Wxz*JUPQud|r@uUQ8`{RyfXmqLCn`T!;oOpX*
zMhC(`A4S%H%v{-?q1u%Ll2>UAxl|l0)Dq`{_EA{t+Ok>`N6f&@Keq<`IhF1Ytmu;p
zO_jsLl7U|sWPL4w-y@`0Fz|_Q?QO|aic1RL-jjop6wtWNwwXa$z{5d<d(CLLpVMEj
zT}c1Xqy?;M=yvO1Ylw3i*(vG)#w<EpqKnWCJR%{+nx2PyIJFq?eq*V+BM6~!{9G2}
zY5vc_{EHIZVYp`++iEj?H0hKGgZ^8ox>MDfs)Lr6vZHEx9;L2y4752zd78q%BF~w}
z#=5hk9#fxjkM<m-Uo4?DV9<>aoauoyfi?&+L6o#ffkT%kV^JzLs$x;8y@lgWaOh!K
z!l&*j6}1>){g@&&Xirsc1pmVqe7QH0T;@LQ$4LWB2aV>0apFZHl17jrZCh40mvstw
z8Yj_5xS@bk2bj^r#i39+KY~7ICeoLmA51Wj+ujIxHQn_2E>J%V>T3;ML{CDoZ|@!M
zl?WPS1dV*jl1NK<SbQzU`(Ee;T#ciqt$TK?Y$z{Ob}%utA>I18CC>E~gKdl)S-H8k
zlMd4JB(BHUGV{Z#^TbI>ro`1%emoBUpy%PL?NK<;@{KaD49408UDs$o!z#AKRl^Se
z$yKkR<`s!6u>;0<UkYaVC#^T1zVrV<KKz$rs*id3yDJi)o7TcMBSf3LB!yl&*`zr{
zR+gHTMjmRUjy~bgTr3Kp{3j@PJAz{kl926G+#HjSe=`N1kaV1vT)u`#olw+a%)()i
z`$*+Cx3xqb8*b-Iw{OO3+Cpgg!I`hK+GQ^a47IY=l+l#p&^YI|f~?lb@X9a8UFQ4v
zQ?q+U1!Q`)ps?Sb(6gnuIV#Gbp+R#9HbV=Sc#amdL=Lyll8_<@o=bV5FUW108u6<*
z3GP&ra^ZPD<&ko3p*rUlXuC|*ed;U1fnzw(dyH2<t*0Z8WuB8^ej{CX{5XE;S0&~F
zk1lcV*|P6CG_YY8*^<byrIAapoy4jJKCe-F`q?cDoXcTn6~EYje7nd$<7V{6*u10#
zO!`Tk_9RlP9ec%lz;1aMs}WM*`Sh(KZ<t1Qgj3{hhM`G&dE@7F%H_~*1}{6pUCLgy
z#qja5yrY2Q_k*KG*c&H);yISl%!3y3QMl`yN>S$zyOPGk$M31qJP++qp7kDf>Qo%%
zCHFL(b6xFYJ-_`|Ey$m&<Tjrpu7L*Qa;Wmv_)uDq^{w5?vtI_Dz_H3xlIEsh(8vg^
zn=fHoSpx51JNu3lEc?Gq9P~vR2lWG1BfPw#7PI4fzu$>b69Lo6B%$1;-orRd)oK^!
zcShl^eFbB12wvy*MscY3_*C3=$e4SOkr3}p(uT(({XdV`?1zopm$u0;DE7F!wOyPk
zF;A8<q-2;b55*8xo-nvDIIEyO1{;{3aOci8!gv<MNxN+4?ZtG;eOX;V7F@RMsDBLe
z5f1heY1{x&@*eUW34`pJ!hSrwyQ%u_6h-Lgv>Hh<vCuq+dlkWim|#qd6L(Qtc(V8V
z3;&d1<v&W+XpnzN<e9g_)dc^Nd7$FlfR`76TxzUL000*=3<s%cFVVN~9wpqf0)p>l
zyoP}!%hmx_p2y^@=&hfcy`nC34hXsZ)-)gE85?^-TOEL~tcy5%`jsKHdKnO|A9Y}+
zBsq!*)qe%TgWE(kV^RrCELGQp`~`&M7gdZg^{HFgZoz;>blYlZR+lp2!2B)3nHvsR
zt<|r#;6!BRXR2R2Oxgv7h8%n<f7+6A<H<%K9O(2&$oEG~1L*q>fmYM$jRfN|<^U&^
z91e#|@v~V&yaahsy?i04xX3R2I6J|#)2m(!R#c)`rJjVUM7pQ^$ukCC4?ljT@2DB&
zDQPuRW%shkPH&=wUUpOcuBHA-S%xr#ma}<2sL!Pl2JyC2{e=PYl1P)+5Jv@n9;m;T
z0gu?r*ElmLe3?J$&Qe>b5_1;+xI@F#mMi}JabKnk{!#dtH#<?}Nf_i0Cj(Ftqj!p9
zXEAM_<>&_`C2vmaN9pC2WEIBUNn>V4>CSXzI8X5k&)7Cn<NGAcyYq};$dt+qB)<7p
g=TU$7HGaZ)do*{9v0q^a|CRv4E|PDB59Qpy0J{UcApigX

literal 0
HcmV?d00001

diff --git a/docs/src/index.md b/docs/src/index.md
new file mode 100644
index 00000000..dfd1cdbe
--- /dev/null
+++ b/docs/src/index.md
@@ -0,0 +1,5 @@
+# Chmy.jl
+
+Documentation for Chmy.jl
+
+Information about the GPU4GEO project can be found on the [GPU4GEO website](https://ptsolvers.github.io/GPU4GEO/)
diff --git a/docs/src/lib/modules.md b/docs/src/lib/modules.md
new file mode 100644
index 00000000..2f6f845e
--- /dev/null
+++ b/docs/src/lib/modules.md
@@ -0,0 +1,50 @@
+# Modules
+
+## Grids
+
+```@autodocs
+Modules = [Chmy.Grids]
+Order   = [:type, :function]
+```
+
+## Architectures
+
+```@autodocs
+Modules = [Chmy.Architectures]
+Order   = [:type, :function]
+```
+
+## Fields
+
+```@autodocs
+Modules = [Chmy.Fields]
+Order   = [:type, :function]
+```
+
+## Grid Operators
+
+```@autodocs
+Modules = [Chmy.GridOperators]
+Order   = [:type, :function]
+```
+
+## Boundary Conditions
+
+```@autodocs
+Modules = [Chmy.BoundaryConditions]
+Order   = [:type, :function]
+```
+
+## Distributed
+
+```@autodocs
+Modules = [Chmy.Distributed]
+Order   = [:type, :function]
+```
+
+## Workers
+
+```@autodocs
+Modules = [Chmy.Workers]
+Order   = [:type, :function]
+```
diff --git a/docs/src/usage/runtests.md b/docs/src/usage/runtests.md
new file mode 100644
index 00000000..c28b0a37
--- /dev/null
+++ b/docs/src/usage/runtests.md
@@ -0,0 +1,27 @@
+# Running tests
+
+## CPU tests
+
+To run the Chmy test suite on the CPU, simple run `test` from within the package mode or using `Pkg`:
+```julia-repl
+using Pkg
+Pkg.test("Chmy")
+```
+
+## GPU tests - needs update!
+
+To run the Chmy 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 GPUs):
+
+```julia-repl
+using Pkg
+Pkg.test("Chmy"; test_args=["--backend=CUDA"])
+```
+
+### For ROC backend (AMD GPUs):
+
+```julia-repl
+using Pkg
+Pkg.test("Chmy"; test_args=["--backend=AMDGPU"])
+```
diff --git a/ext/ChmyAMDGPUExt/ChmyAMDGPUExt.jl b/ext/ChmyAMDGPUExt/ChmyAMDGPUExt.jl
index 5584ac0d..838bbf96 100644
--- a/ext/ChmyAMDGPUExt/ChmyAMDGPUExt.jl
+++ b/ext/ChmyAMDGPUExt/ChmyAMDGPUExt.jl
@@ -2,8 +2,18 @@ module ChmyAMDGPUExt
 
 using AMDGPU, KernelAbstractions, Chmy
 
+import Chmy.Architectures: heuristic_groupsize, set_device!, get_device
+
 Base.unsafe_wrap(::ROCBackend, ptr::Ptr, dims) = unsafe_wrap(ROCArray, ptr, dims; lock=false)
 
 Chmy.pointertype(::ROCBackend, T::DataType) = Ptr{T}
 
+set_device!(dev::HIPDevice) = AMDGPU.device!(dev)
+
+get_device(::ROCBackend, id::Integer) = HIPDevice(id)
+
+heuristic_groupsize(::HIPDevice, ::Val{1}) = (256, )
+heuristic_groupsize(::HIPDevice, ::Val{2}) = (128, 2, )
+heuristic_groupsize(::HIPDevice, ::Val{3}) = (128, 2, 1, )
+
 end
diff --git a/ext/ChmyCUDAExt/ChmyCUDAExt.jl b/ext/ChmyCUDAExt/ChmyCUDAExt.jl
index ecbecc28..f1c3dc5e 100644
--- a/ext/ChmyCUDAExt/ChmyCUDAExt.jl
+++ b/ext/ChmyCUDAExt/ChmyCUDAExt.jl
@@ -2,8 +2,18 @@ module ChmyCUDAExt
 
 using CUDA, KernelAbstractions, Chmy
 
+import Chmy.Architectures: heuristic_groupsize, set_device!, get_device
+
 Base.unsafe_wrap(::CUDABackend, ptr::CuPtr, dims) = unsafe_wrap(CuArray, ptr, dims)
 
 Chmy.pointertype(::CUDABackend, T::DataType) = CuPtr{T}
 
+set_device!(dev::CuDevice) = CUDA.device!(dev)
+
+get_device(::CUDABackend, id::Integer) = CuDevice(id - 1)
+
+heuristic_groupsize(::CuDevice, ::Val{1}) = (256,)
+heuristic_groupsize(::CuDevice, ::Val{2}) = (32, 8)
+heuristic_groupsize(::CuDevice, ::Val{3}) = (32, 8, 1)
+
 end
diff --git a/test/Project.toml b/test/Project.toml
new file mode 100644
index 00000000..b7c500b4
--- /dev/null
+++ b/test/Project.toml
@@ -0,0 +1,13 @@
+[deps]
+KernelAbstractions = "63c18a36-062a-441e-b654-da1e3ab1ce7c"
+MPI = "da04e1cc-30fd-572f-bb4f-1f8673147195"
+Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[weakdeps]
+AMDGPU = "21141c5a-9bdb-4563-92ae-f87d6854732e"
+CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"
+
+[compat]
+AMDGPU = "0.8"
+CUDA = "5"
diff --git a/test/common.jl b/test/common.jl
new file mode 100644
index 00000000..dcb18a4a
--- /dev/null
+++ b/test/common.jl
@@ -0,0 +1,15 @@
+using Test
+using Chmy
+
+using KernelAbstractions
+
+# add KA backends
+backends = KernelAbstractions.Backend[CPU()]
+
+if get(ENV, "JULIA_CHMY_BACKEND", "") == "AMDGPU"
+    using AMDGPU
+    AMDGPU.functional() && push!(backends, ROCBackend())
+elseif get(ENV, "JULIA_CHMY_BACKEND", "") == "CUDA"
+    using CUDA
+    CUDA.functional() && push!(backends, CUDABackend())
+end
diff --git a/test/runtests.jl b/test/runtests.jl
index cc57e86a..d8faa932 100644
--- a/test/runtests.jl
+++ b/test/runtests.jl
@@ -1 +1,75 @@
 using Test
+using Chmy
+
+using Pkg
+
+excludedfiles = ["test_excluded.jl"]
+
+# distributed
+using MPI
+
+function parse_flags!(args, flag; default=nothing, typ=typeof(default))
+    for f in args
+        startswith(f, flag) || continue
+
+        if f != flag
+            val = split(f, '=')[2]
+            if !(typ ≡ nothing || typ <: AbstractString)
+                @show typ val
+                val = parse(typ, val)
+            end
+        else
+            val = default
+        end
+
+        filter!(x -> x != f, args)
+        return true, val
+    end
+    return false, default
+end
+
+function runtests()
+    exename   = joinpath(Sys.BINDIR, Base.julia_exename())
+    testdir   = pwd()
+    istest(f) = endswith(f, ".jl") && startswith(basename(f), "test_")
+    testfiles = sort(filter(istest, vcat([joinpath.(root, files) for (root, dirs, files) in walkdir(testdir)]...)))
+
+    nfail = 0
+    printstyled("Testing package Chmy.jl\n"; bold=true, color=:white)
+
+    for f in testfiles
+        println("")
+        if basename(f) ∈ excludedfiles
+            println("Test Skip:")
+            println("$f")
+            continue
+        end
+        try
+            # if basename(f) ∈ test_distributed
+            #     nprocs = contains(f, "2D") ? nprocs_2D : nprocs_3D
+            #     cmd(n=nprocs) = `$(mpiexec()) -n $n $exename --startup-file=no --color=yes $(joinpath(testdir, f))`
+            #     withenv("JULIA_NUM_THREADS" => "4") do
+            #         run(cmd())
+            #     end
+            # else
+                run(`$exename --startup-file=no $(joinpath(testdir, f))`)
+            # end
+        catch ex
+            @error ex
+            nfail += 1
+        end
+    end
+    return nfail
+end
+
+_, backend_name = parse_flags!(ARGS, "--backend"; default="CPU", typ=String)
+
+@static if backend_name == "AMDGPU"
+    Pkg.add("AMDGPU")
+    ENV["JULIA_CHMY_BACKEND"] = "AMDGPU"
+elseif backend_name == "CUDA"
+    Pkg.add("CUDA")
+    ENV["JULIA_CHMY_BACKEND"] = "CUDA"
+end
+
+exit(runtests())
diff --git a/test/test_fields.jl b/test/test_fields.jl
new file mode 100644
index 00000000..eb8ec753
--- /dev/null
+++ b/test/test_fields.jl
@@ -0,0 +1,54 @@
+include("common.jl")
+
+using Chmy.Architectures
+using Chmy.Fields
+using Chmy.Grids
+
+for backend in backends
+    @testset "$(basename(@__FILE__)) (backend: $backend)" begin
+        arch = Arch(backend)
+        grid = UniformGrid(arch; origin=(0.0, 0.0, 0.0), extent=(1.0, 1.0, 1.0), dims=(2, 2, 2))
+        loc = (Center(), Vertex(), Center())
+        @testset "location" begin
+            @test location(Field(backend, grid, Center())) == (Center(), Center(), Center())
+            @test location(Field(backend, grid, loc)) == loc
+        end
+        @testset "set" begin
+            f = Field(backend, grid, (Center(), Vertex(), Center()); halo=(1, 0, 1))
+            @testset "discrete" begin
+                # no parameters vertex
+                fill!(parent(f), NaN)
+                set!(f, grid, (grid, loc, I) -> ycoord(grid, loc, I[2]); discrete=true)
+                @test Array(interior(f)) == [0.0; 0.0;; 0.5; 0.5;; 1.0; 1.0;;;
+                                             0.0; 0.0;; 0.5; 0.5;; 1.0; 1.0]
+                # no parameters center
+                fill!(parent(f), NaN)
+                set!(f, grid, (grid, loc, I) -> xcoord(grid, loc, I[1]); discrete=true)
+                @test Array(interior(f)) == [0.25; 0.75;; 0.25; 0.75;; 0.25; 0.75;;;
+                                             0.25; 0.75;; 0.25; 0.75;; 0.25; 0.75]
+                # with parameters
+                fill!(parent(f), NaN)
+                set!(f, grid, (grid, loc, I, sc) -> ycoord(grid, loc, I[2]) * sc; discrete=true, parameters=(2.0,))
+                @test Array(interior(f)) == [0.0; 0.0;; 1.0; 1.0;; 2.0; 2.0;;;
+                                             0.0; 0.0;; 1.0; 1.0;; 2.0; 2.0]
+            end
+            @testset "continuous" begin
+                # no parameters vertex
+                fill!(parent(f), NaN)
+                set!(f, grid, (x, y, z) -> y)
+                @test Array(interior(f)) == [0.0; 0.0;; 0.5; 0.5;; 1.0; 1.0;;;
+                                             0.0; 0.0;; 0.5; 0.5;; 1.0; 1.0]
+                # no parameters center
+                fill!(parent(f), NaN)
+                set!(f, grid, (x, y, z) -> x)
+                @test Array(interior(f)) == [0.25; 0.75;; 0.25; 0.75;; 0.25; 0.75;;;
+                                             0.25; 0.75;; 0.25; 0.75;; 0.25; 0.75]
+                # with parameters
+                fill!(parent(f), NaN)
+                set!(f, grid, (x, y, z, sc) -> y * sc; parameters=(2.0,))
+                @test Array(interior(f)) == [0.0; 0.0;; 1.0; 1.0;; 2.0; 2.0;;;
+                                             0.0; 0.0;; 1.0; 1.0;; 2.0; 2.0]
+            end
+        end
+    end
+end