Configs. Tests now work and more expansive. Fix link in docs

Author: nichollsh

.github/workflows/install_and_test.yml

@@ -18,7 +18,8 @@ jobs:
     runs-on: ubuntu-latest
     name: install_and_test
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
       # Setup system
       - name: NetCDF
@@ -42,7 +43,8 @@ jobs:
           repository: 'nichollsh/SOCRATES'
           path: 'SOCRATES'
 
-      - uses: actions/cache@v4
+      - name: Restore SOCRATES from cache
+        uses: actions/cache@v4
         id: cache-socrates
         with:
           path: |
@@ -51,7 +53,7 @@ jobs:
             SOCRATES/set_rad_env
           key: socrates-${{ hashFiles('SOCRATES/version') }}
 
-      - name: Build SOCRATES
+      - name: Build SOCRATES if required
         if: steps.cache-socrates.outputs.cache-hit != 'true'
         run: |
           export LD_LIBRARY_PATH=""
@@ -69,18 +71,17 @@ jobs:
           julia --project=. -e 'using Pkg; Pkg.build()'
 
       # Run the tests
-      - name: Test AGNI
+      - name: Run AGNI test suite
         run: |
           export RAD_DIR="/home/runner/work/AGNI/AGNI/SOCRATES"
           export LD_LIBRARY_PATH=""
           julia --project=. -e 'using Pkg; Pkg.test()'
 
-      # Upload result if tests fail
+      # Upload output dir for inspection by user
       - name: Upload result as artifact
-        if: failure()
         uses: actions/upload-artifact@v4
         with:
-          name: test-failure-artifact
+          name: test-artifact
           path: |
             out/*
 

README.md

@@ -26,7 +26,7 @@
 ## Overview
 AGNI's primary purpose is to simulate the atmospheric temperature-, height-, and compositional-structures of atmospheres overlying magma oceans. It does this while ensuring that radiative-convective equilibrium is maintained throughout the atmosphere. SOCRATES is used to perform correlated-k radiative transfer including: shortwave irradiation from the star, surface emission, line absorption, Rayleigh scattering, parameterised clouds, and collisional absorption. Mixing length theory is used to parametrise convection. AGNI also supports real gas equations of state, self-gravitation, and various spectral surface compositions. Accounting for these energy transport processes permits an energy-conserving calculation of atmospheric structure, obtained using numerical optimisation, which also yields realistic cooling rates for young rocky planets with magma oceans.
 
-Consult the [AGNI documentation](https://www.h-nicholls.space/AGNI/) for information about the model.
+Consult the [AGNI documentation](https://www.h-nicholls.space/AGNI/) for information about the model, including usage, functionality, and how to contribute.
 
 Contact: see information on [my website homepage](https://www.h-nicholls.space/).
 

docs/src/contributors.md

@@ -8,5 +8,6 @@ I would like to thank the following people for their assistance during the ongoi
 * [Arjun Savel](https://www.arjunsavel.com/) -- JOSS paper reviewer
 * [Ryan Macdonald](https://distantworlds.space/) -- JOSS paper reviewer
 * [Boding Ouyang](https://github.com/OYBDOOO)
+* [Stuart Daines](https://scholar.google.com/citations?user=EZqVB7wAAAAJ)
 
 Please contact [Harrison Nicholls](https://www.h-nicholls.space/) for any queries relating to AGNI.

docs/src/manual.md

@@ -1,7 +1,7 @@
 # Software manual
 
 ## Contributing
-If you are interested in contributing to the model, please see the [contributing](@ref) page
+If you are interested in contributing to the model, please see the [contributing](contributing.md) page
 
 ## Code reference (API)