Merge pull request #67 from nichollsh/joss

JOSS paper draft

.github/workflows/documentation.yml

@@ -1,11 +1,16 @@
 # This job updates the documentation and pushes it to GitHub pages
 # This occurs when a PR to main is merged
 
-name: Documentation
+name: Docs
 
 on:
   push:
     branches: [main]
+    paths:
+      - docs/**
+      - !docs/paper/**
+      - .github/workflows/documentation.yml
+
 
 jobs:
   build:

.github/workflows/draft-pdf.yml

@@ -0,0 +1,28 @@
+name: Draft PDF
+on:
+  push:
+    paths:
+      - docs/paper/**
+      - .github/workflows/draft-pdf.yml
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: docs/paper/paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: docs/paper/paper.pdf

.github/workflows/install_and_test.yml

@@ -1,7 +1,7 @@
 # This job installs AGNI and SOCRATES, and tests AGNI
 # This occurs when a PR to main is created
 
-name: AGNI_main_tests
+name: Tests
 
 on:
   pull_request:
@@ -12,7 +12,7 @@ on:
 jobs:
   install:
     runs-on: ubuntu-latest
-    name: AGNI_main_tests
+    name: install_and_test
     steps:
       - uses: actions/checkout@v4
 

.gitignore

@@ -40,3 +40,6 @@ __pycache__
 debug/
 nogit*
 .osfcli.config
+
+# Paper
+paper/main.pdf

CITATION.cff

@@ -5,7 +5,7 @@ authors:
   given-names: "Harrison"
   orcid: "https://orcid.org/0000-0002-8368-4641"
 title: "AGNI"
-version: 0.8.1
+version: 0.8.2
 doi: 10.xx/xx.xx
 date-released: 2024-09-13
 url: "https://github.com/nichollsh/AGNI"

Project.toml

@@ -1,7 +1,7 @@
 name = "AGNI"
 uuid = "ede838c1-9ec3-4ebe-8ae8-da4091b3f21c"
 authors = ["Harrison Nicholls <[email protected]>"]
-version = "0.8.1"
+version = "0.8.2"
 
 [deps]
 ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"

codemeta.json

@@ -7,17 +7,17 @@
       "@type": "Person",
       "email": "[email protected]",
       "name": "Harrison Nicholls",
-      "affiliation": "University of Oxford"
+      "affiliation": "Department of Physics, University of Oxford, Parks Road, Oxford OX1 3PU, UK"
     }
   ],
   "identifier": "",
   "codeRepository": "https://github.com/nichollsh/AGNI",
   "datePublished": "2024-09-13",
   "dateModified": "2024-09-13",
   "dateCreated": "2024-09-13",
-  "description": "A 1D radiative-convective model for the atmospheres of hot terrestrial planets.",
-  "keywords": "fortran, julia, physics, radiative-transfer, exoplanets, convection, radiation, planetary-science, atmosphere-model",
+  "description": "A radiative-convective model for the atmospheres of rocky planets",
+  "keywords": "physics, radiative transfer, exoplanets, astronomy, convection, radiation, planets, atmospheres",
   "license": "GPL v3.0",
   "title": "AGNI",
-  "version": "0.8.1"
+  "version": "0.8.2"
 }