JOSS publication

[lsoucasse]

We aim at publishing the PROTEUS software in JOSS. This should happen once we incorporate Aragog and publish at least a first release of PROTEUS as a python package.

The paper consists in a short markdown file (example here) containing a summary, a statement of interest and appropriate references. This file needs to be hosted in the Github repository and compiled using this GH action. It is also approciated to have a couple of tutorials, highlighting use cases and documenting how it works.

The review process is open and happens on Github, see here. Submission requirements are listed here.

[timlichtenberg]

Indeed, this is a clear plan to do in the first half of 2025. I suggest we discuss the approximate schedule and steps do before this submission in one of the next PROTEUS meetings, and then add these steps and timeline here as a guideline.

[timlichtenberg]

To achieve before we can:

• PyPi installation needs to work from scratch
• Extend the documentation to include running instructions for PyPi version and developer install
• Create a minimum example Juypter notebook for running the code

[timlichtenberg]

Currently anticipated timeline for JOSS publication:

~March: Write Draft of Paper
~April: Submit to JOSS