JOSS paper checklist

[BenWibking]

I suggested that we write a Journal of Open Source Software paper about jaff. A summary of the requirements and review criteria are:

• Make your software available in an open repository (GitHub, Bitbucket, etc.) and
• Include an OSI approved open source license. (add LICENSE and CONTRIBUTING.md files #19)
• 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.
  • documentation (add AI-generated documentation #14)
  • feature completeness:
    • parsers
    • tabular output
    • Python output
    • Fortran output
    • Add plugin to generate portable C++ code #23
    • special function dictionary
  • automated tests
    • parsers (with pytests)
    • tabular output (as a Python notebook)
    • Python output (as a Python notebook)
    • Add plugin to generate portable C++ code #23
    • special function dictionary
    • add fortran codegen notebook #27
• 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.
  • [WIP] JOSS manuscript #31
• (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.