[Journal of Open Source Software] Paper

[UnravelSports]

Hi,

We've had the idea to create a Kloppy paper and submit it to JOSS for a while now.

They have a relatively simple submission process it seems. The main thing is to add a paper.md to an up-to-date branch (doesn't have to be master). The paper should be between 250 and 1000 words.

Here are more details on paper.md, and here is the subsection on Compiling the paper.

This Draft PR contains a paper.md I've created, which is not perfect both in content and in layout, but I figured I'd share it to get this ball rolling.

Submission Process

Before you submit, you should:

• Make your software available in an open repository (GitHub, Bitbucket, etc.) and include an OSI approved open source license.
• Make sure that the software complies with the JOSS review criteria. In particular, your software should be full-featured, well-documented, and contain procedures (such as automated tests) for checking correctness.
• Write a short paper in Markdown format using paper.md as file name, including a title, summary, author names, affiliations, and key references. See our example paper to follow the correct format.
• (Optional) create a metadata file describing your software and include it in your repository. We provide a script that automates the generation of this metadata.

---

Compiling

I compiled the paper locally to test, first you run:

docker run --rm \                                      
    --platform linux/amd64 \
    --volume $PWD/paper:/data \
    --user $(id -u):$(id -g) \
    --env JOURNAL=joss \
    openjournals/inara

This process is Killed for some reason, but after you the below command it converts to pdf just fine. This is obviously not optimal...

pandoc paper/jats/paper.jats -f jats -o paper/paper.pdf