diff --git a/.gitignore b/.gitignore index 558f87d2d..dc699790d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ build/* docs/_build/* docs/_downloads +docs/paper-v4/paper.pdf docs/jupyter_execute/* docs/.jupyter_cache/* docs/reference diff --git a/ci/local-build-v4-paper.sh b/ci/local-build-v4-paper.sh new file mode 100755 index 000000000..12ae1957a --- /dev/null +++ b/ci/local-build-v4-paper.sh @@ -0,0 +1,19 @@ +#!/usr/bin/env bash +# Build the v4 paper PDF locally, mirroring openjournals/openjournals-draft-action +# (used in .github/workflows/paper-v4.yml). Requires Docker. +# Output: docs/paper-v4/paper.pdf +set -euo pipefail + +REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +JOURNAL="${JOURNAL:-joss}" + +docker run --rm \ + --volume "${REPO_ROOT}:/data" \ + --workdir /data \ + --user "$(id -u):$(id -g)" \ + --env JOURNAL="${JOURNAL}" \ + --env GIT_SHA="$(git -C "${REPO_ROOT}" rev-parse HEAD)" \ + openjournals/inara:latest \ + -o pdf docs/paper-v4/paper.md + +echo "Built ${REPO_ROOT}/docs/paper-v4/paper.pdf" diff --git a/docs/paper-v4/paper.md b/docs/paper-v4/paper.md index 346f66958..33925400e 100644 --- a/docs/paper-v4/paper.md +++ b/docs/paper-v4/paper.md @@ -104,6 +104,8 @@ Figure 2 shows the varied types of data and grid geometries that we combine, alo Parcels has been cited in over 330 peer reviewed scientific papers so far mostly within the field of oceanography. +Version 4 of Parcels, as highlighted in the [Statement of need](#statement-of-need), focusses on three main areas: native compatibility with Xarray datasets, working with different grid geometries, and supporting cross domain tooling. These features were not present in previous versions of Parcels. + # AI usage disclosure Large Language Models (Claude Opus 4.6, ChatGPT , GitHub Copilot) have been used in a guided manner for code generation, documentation, refactoring, and testing.