Potential submission to JOSS?

[ml-evs]

Just starting an issue to discuss the possibility of creating a JOSS submission for thie repository, once we're at v1.0 and the OPTiMaDe paper itself is out (i.e. a few months down the line).

This would involve writing a short summary of the project, and getting the repository itself reviewed externally by the JOSS reviewers. We already tick almost all the boxes for submission (in terms of doing open software "right") so hopefully this would just be a good way to advertise the repo in more detail than in the main paper. Ideally all contributors would/could be authors, so if we decide to go ahead we can start contacting people.

Thoughts?

[ml-evs]

I'm going to start writing this when I get the odd free moment, assuming that @CasperWA is still down for this.

@shyamd and @markus1978 do you want to be involved and on the paper? This involvement may amount to writing the short use-case descriptions/tutorials that we have spoken about (as @markus1978 is already doing at #666).

[shyamd]

Definately want to be involved. I've got some major deadlines between now and April 6. I will be freer after that to help with this, docs, and other optimade issues.

[markus1978]

Thanks for the initiative. I would gladly write a more paper friendly version of the NOMAD use-case.

Best, Markus

On 18.03.21 20:55, Matthew Evans wrote:

I'm going to start writing this when I get the odd free moment, assuming that @CasperWA https://github.com/CasperWA is still down for this.

@shyamd https://github.com/shyamd and @markus1978 https://github.com/markus1978 do you want to be involved and on the paper? This involvement may amount to writing the short use-case descriptions/tutorials that we have spoken about (as @markus1978 https://github.com/markus1978 is already doing at #666 https://github.com/Materials-Consortia/optimade-python-tools/pull/666).

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Materials-Consortia/optimade-python-tools/issues/203#issuecomment-802245233, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA2WUXEZOYUQSEGD6SURX6DTEJLDXANCNFSM4LBI2BTA.

[ml-evs]

Great!

The paper itself does not need to be long at all, but reviewers will check that our docs/tutorials are complete, which is where the use case discussions would come in @markus1978, so there shouldn't be any extra work on that side.

Definately want to be involved. I've got some major deadlines between now and April 6. I will be freer after that to help with this, docs, and other optimade issues.

@shyamd: I don't think much will really need to be done by then; the paper itself is routine and does not need 4 people to write it, though after submission it would be great to help deal with issues arising from the review. On the use-case side, I will probably write one myself about plugging into an existing MongoDB, which should be sufficient for JOSS and can be beefed up in the future; perhaps you could write something that focuses more on deployment and any headaches you've had regarding filtering on existing fields in a database?

We should catch up on this after the OPTIMADE meeting next week and discuss whether publishing the paper will lead to a v1.0 release and the end of "active" development, or whether there's still more we can do (outside of the existing issues we know about and general improvements to existing code, e.g. the flexibility of the config).

[ml-evs]

How should we approach adding other authors? I think anyone on the contributors list is probably fair game...