[joss] Paper

.github/workflows/paper.yaml

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: 2025 OPAL-RT Germany GmbH
+# SPDX-License-Identifier: Apache-2.0
+
+---
+name: Draft PDF
+
+on:
+  push:
+    paths:
+        - paper/**
+        - .github/workflows/paper.yaml
+
+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@v1.0
+      with:
+        journal: joss
+        paper-path: paper/paper.md
+
+    - name: Upload
+      uses: actions/upload-artifact@v4
+      with:
+        name: paper
+        path: paper/paper.pdf

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
     rev: v5.0.0
     hooks:
       - id: trailing-whitespace
-        exclude: \.patch$
+        exclude: \.patch$|^paper\.md$
       - id: end-of-file-fixer
         exclude: \.(svg|patch)$
       - id: check-ast
@@ -19,6 +19,7 @@ repos:
         exclude: .devcontainer/devcontainer\.json
       - id: check-toml
       - id: check-added-large-files
+        exclude: ^paper\.md$
       - id: pretty-format-json
         # black has its own mind of formatting Jupyter notebooks
         exclude: \.ipynb$|^.devcontainer/devcontainer\.json$|package-lock\.json$
@@ -54,4 +55,5 @@ repos:
     rev: "v0.13.0"
     hooks:
       - id: markdownlint
+        exclude: ^paper\.md$
         args: [-r, "~MD013,~MD033,~MD024"]

README.md

@@ -1,6 +1,7 @@
 # <img src="doc/pictures/villas_node.png" width=40 /> VILLASnode
 
 [![build status](https://git.rwth-aachen.de/acs/public/villas/node/badges/master/pipeline.svg)](https://git.rwth-aachen.de/acs/public/villas/node/-/pipelines/)
+[![status](https://joss.theoj.org/papers/37c2509d36586f4cec2885d5c2088e8f/status.svg)](https://joss.theoj.org/papers/37c2509d36586f4cec2885d5c2088e8f)
 
 This is VILLASnode, a gateway for processing and forwarding simulation data between real-time simulators.
 VILLASnode is a client/server application to connect simulation equipment and software such as:

REUSE.toml

@@ -24,6 +24,9 @@ path = [
     "etc/labs/lab3.pcap",
     "tests/valgrind.supp",
     "packaging/archlinux/villas-node.install",
+    "paper/figures/**",
+    "paper/paper.md",
+    "paper/paper.bib",
 ]
 precedence = "aggregate"
 SPDX-FileCopyrightText = "2018-2023, Institute for Automation of Complex Power Systems, RWTH Aachen University"