Boilerplate for JOSS paper

.github/workflows/draft-pdf.yml

@@ -0,0 +1,25 @@
+name: Draft PDF
+on:
+  push:
+    paths:
+      - 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: paper/main.md
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: paper
+          path: paper/main.pdf

.gitignore

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

codemeta.json

@@ -15,8 +15,8 @@
   "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 terrestrial planets",
+  "keywords": "fortran, julia, physics, radiative-transfer, exoplanets, astronomy, convection, radiation, planets, atmospheres",
   "license": "GPL v3.0",
   "title": "AGNI",
   "version": "0.8.1"

paper/main.md

@@ -0,0 +1,78 @@
+---
+title: 'AGNI: A radiative-convective model for the atmospheres of terrestrial planets'
+tags:
+  - Julia
+  - Fortran
+  - astronomy
+  - physics,
+  - radiative transfer
+  - exoplanets
+  - convection
+  - radiation
+  - planets
+  - atmospheres
+authors:
+  - name: Harrison Nicholls
+    orcid: 0000-0002-8368-4641
+    affiliation: 1
+affiliations:
+ - name: University of Oxford
+   index: 1
+date: 13 September 2024
+bibliography: refs.bib
+
+---
+
+# Summary
+
+The forces on stars, galaxies, and dark matter under external gravitational
+fields lead to the dynamical evolution of structures in the universe. The orbits
+of these bodies are therefore key to understanding the formation, history, and
+future state of galaxies. The field of "galactic dynamics," which aims to model
+the gravitating components of galaxies to study their structure and evolution,
+is now well-established, commonly taught, and frequently used in astronomy.
+Aside from toy problems and demonstrations, the majority of problems require
+efficient numerical tools, many of which require the same base code (e.g., for
+performing numerical orbit integration).
+
+# Statement of need
+
+`Gala` is an Astropy-affiliated Python package for galactic dynamics. Python
+enables wrapping low-level languages (e.g., C) for speed without losing
+flexibility or ease-of-use in the user-interface. The API for `Gala` was
+designed to provide a class-based and user-friendly interface to fast (C or
+Cython-optimized) implementations of common operations such as gravitational
+potential and force evaluation, orbit integration, dynamical transformations,
+and chaos indicators for nonlinear dynamics. `Gala` also relies heavily on and
+interfaces well with the implementations of physical units and astronomical
+coordinate systems in the `Astropy` package [@IAPWS95]
+
+# Mathematics
+
+Single dollars ($) are required for inline mathematics e.g. $f(x) = e^{\pi/x}$
+
+Double dollars make self-standing equations:
+
+$$\Theta(x) = \left\{\begin{array}{l}
+0\textrm{ if } x < 0\cr
+1\textrm{ else}
+\end{array}\right.$$
+
+You can also use plain \LaTeX for equations
+\begin{equation}\label{eq:fourier}
+\hat f(\omega) = \int_{-\infty}^{\infty} f(x) e^{i\omega x} dx
+\end{equation}
+and refer to \autoref{eq:fourier} from text.
+
+# Citations
+
+Citations to entries in paper.bib should be in
+[rMarkdown](http://rmarkdown.rstudio.com/authoring_bibliographies_and_citations.html)
+format.
+
+# Acknowledgements
+
+We acknowledge contributions from Brigitta Sipocz, Syrtis Major, and Semyeong
+Oh, and support from Kathryn Johnston during the genesis of this project.
+
+# References