JOSS paper

[navidcy]

Added the JOSS template. Let's work on this! 🎉

After every commit that modifies the paper.md markdown file a GitHub action is called that compiles the PDF version of the paper and commits it in the paper directory. See, e.g., 9ea312f.

[navidcy]

Relevant discussion in #42

[ashjbarnes]

Is the workflow here to keep this PR open as we work on the paper together and merge when we're happy?

[navidcy]

Yes, that's the idea. Keep the PR open, work on it, submit to JOSS (still the PR is open) and we merge only when it's accepted after the reviews etc.

[ashjbarnes]

Is there a good way to build / test locally? I keep pushing when the formatting breaks to test which seems inefficient!

[navidcy]

Is there a good way to build / test locally? I keep pushing when the formatting breaks to test which seems inefficient!

Ignore the tests anyway. We are not changing any part of the code.

I don’t know the answer to your question. That’s how I was doing it other times. You can look into this in JOSS website but if it’s just so the “the tests don’t stop” I wouldn’t bother.

[ashjbarnes]

Order of authors wasn't meant to be a decision too btw I was just putting them on the paper

[ashjbarnes]

@dhruvbhagtani @ChrisC28 @reillyja @aekiss all contributors to the package on Github are welcome to contribute to the paper. Here's what we've got so far - any feedback or suggestions would be great :) Apparently a 2-3 page written report is normal for JOSS papers. We also need to make sure that the documentation / readthedocs page are in a good state for the reviewers too

[navidcy]

@ashjbarnes could I make some edits and commit (instead of suggestions in the PR)? are you done for the moment?

[ashjbarnes]

@ashjbarnes could I make some edits and commit (instead of suggestions in the PR)? are you done for the moment?

Ok that was my last commit of some changes I'd made to incorporate your feedback. Go for it!

[navidcy]

The caption of the figure insists not appearing... hm...

[dhruvbhagtani]

The manuscript looks great! Suggesting some areas of discussion (please feel free to ignore any or all of them):

1. It might be useful to have a figure explaining regional modelling like - downscaling from global to your region of interest that we can highlight (which can be Tasmania and we can then explain our example notebook as well, more on that below).
2. I don't know if there are plans on this or not, but reading other papers in JOSS, I realised that having a more extensive example within the paper could be useful. We can use our Tassie example for this.

I can go through these example codes later in the week and make edits if needed.

[navidcy]

I admit I haven't read the manuscript in detail yet. I'll do it today (not holiday in Cyprus) and will add comments or restructure a bit.

[navidcy]

I also think that we should definitely mention https://gmd.copernicus.org/articles/16/1481/2023/

@article{polton2023reproducible,
    author  = {Polton, J. and Harle, J. and Holt, J. and Katavouta, A. and Partridge, D. and Jardine, J. and Wakelin, S. and Rulent, J. and Wise, A. and Hutchinson, K. and Byrne, D. and Bruciaferri, D. and O'Dea, E. and De Dominicis, M. and Mathiot, P. and Coward, A. and Yool, A. and Palmi\'eri, J. and Lessin, G. and Mayorga-Adame, C. G. and Le Guennec, V. and Arnold, A. and Rousset, C.},
    title   = {Reproducible and relocatable regional ocean modelling: fundamentals and practices},
    journal = {Geoscientific Model Development},
    volume  = {16},
    year    = {2023},
    number  = {5},
    pages   = {1481--1510},
    doi     = {10.5194/gmd-16-1481-2023}
}

[navidcy]

congrats all!
paper is published

@PaulSpence (left) handing the 2024 COSIMA Most Selfless Contributor Award to @ashjbarnes (right); July 1st, 2024, Canberra, Australia