JOSS paper about t8code

View the paper: paper.pdf.

Edit the paper: paper.md

Intro

The Journal of Open Source Software (JOSS) is a developer friendly journal for research software packages.

JOSS is an academic journal (ISSN 2475-9066) with a formal peer-review process that is designed to improve the quality of the software submitted. Upon acceptance into JOSS, we mint a CrossRef DOI for your paper and we list it on the JOSS website.

Useful links

• Main page: https://joss.readthedocs.io/en/latest/index.html
• Submission guidelines: https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements
• Compiling the paper:
  • Different ways
  • JOSS Github Action
  • Auto-commit generated PDF to Repo

Submission Requirements

t8code specific checklist of the submission requirements as given by JOSS:

• The software must be open source as per the OSI definition.

• The software must be hosted at a location where users can open issues and propose code changes without manual approval of (or payment for) accounts.

• The software must have an obvious research application.

• You must be a major contributor to the software you are submitting, and have a GitHub account to participate in the review process.

• Your paper must not focus on new research results accomplished with the software.

• Your paper (paper.md and BibTeX files, plus any figures) must be hosted in a Git-based repository together with your software (although they may be in a short-lived branch which is never merged with the default).

In addition, the software associated with your submission must:

• Be stored in a repository that can be cloned without registration.

• Be stored in a repository that is browsable online without registration.

• Have an issue tracker that is readable without registration.

• Permit individuals to create issues/file tickets against your repository.

What should the paper contain?

• A list of the authors of the software and their affiliations, using the correct format (see the example below).

• A summary describing the high-level functionality and purpose of the software for a diverse, non-specialist audience.

• A Statement of need section that clearly illustrates the research purpose of the software and places it in the context of related work.

• A list of key references, including to other software addressing related needs. Note that the references should include full names of venues, e.g., journals and conferences, not abbreviations only understood in the context of a specific discipline.

• Mention (if applicable) a representative set of past or ongoing research projects using the software and recent scholarly publications enabled by it.

• Acknowledgement of any financial support.