Add tests to ci

.github/workflows/documentation.yml

@@ -8,6 +8,28 @@ on:
   pull_request:
 
 jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.10'
+        os:
+          - ubuntu-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: julia-actions/cache@v1
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+
   build:
     permissions:
       actions: write

docs/src/tutorial.jl

@@ -123,3 +123,10 @@ containers = initialize(options)
 #
 # The result is saved in
 containers.X
+
+# Each column in `containers.X` contains the results for a time step.
+# In each column, the first ``2 N_b`` correspond to the fluid temperatures. In particular,  
+# the odd entries `containers.X[1:2:2Nb, :]` are the inlet temperatures, while the even entries `containers.X[2:2:2Nb, :]`   
+# are the outlet temperatures of each borehole.
+# The next ``Nb`` values `containers.X[2Nb+1:3Nb, :]` are the borehole wall temperatures.
+# The last ``Nb`` values `containers.X[3Nb+1:4Nb, :]` are the heat extraction of each borehole.

docs/src/tutorial.md

@@ -152,4 +152,10 @@ The result is saved in
 
 ````
 containers.X
-````
+````
+
+Each column in `containers.X` contains the results for a time step.
+In each column, the first ``2 N_b`` correspond to the fluid temperatures. In particular,  
+the odd entries `containers.X[1:2:2Nb, :]` are the inlet temperatures, while the even entries `containers.X[2:2:2Nb, :]` are the outlet temperatures of each borehole.
+The next ``N_b`` values `containers.X[2Nb+1:3Nb, :]` are the borehole wall temperatures.
+The last ``N_b`` values `containers.X[3Nb+1:4Nb, :]` are the heat extraction of each borehole.