ggciag / mandyoc

MANDYOC is a finite element code written on top of the PETSc library to simulate thermo-chemical convection of the Earth's mantle
https://ggciag.github.io/mandyoc/
BSD 3-Clause "New" or "Revised" License
27 stars 5 forks source link

JOSS REVIEW: Paper #54

Closed rbeucher closed 2 years ago

rbeucher commented 2 years ago

I think the paper needs a bit of work.

psanan commented 2 years ago

Re several of the points above, I strongly agree that the submission is missing information and citations to position itself relative to other pieces of free and/or open source software which solve similar problems. Strict novelty is not a requirement for publication, but it's important for readers to know what differentiates this code from others they may have used or read about, both in terms of the physical problems it solves (in particular, with regards to surface processes) and in terms of the practical usage of the software.

Re point 3, I think that the template is a little confusing in mixing literal section headings with section headings that describe how to format things ("Mathematics", "Citations", "Figures") that don't need to be literally included.

Re Point 4, I would argue that the choice of example to include is fine, especially given that the van Keken benchmark is nicely presented in your documentation, this benchmark is presumably identical to the one in examples/, and this example does a good job of showing a reproducible experiment quite similar to ones other researchers might want to run with the code.

victorsacek commented 2 years ago

The paper was updated following the suggestions of the reviewers:

Addresses Issue #54.

psanan commented 2 years ago

My concerns have been addressed wrt this issue, so consider my comment above "resolved".

psanan commented 2 years ago

One further minor comment on the paper (and documentation in general). As far as I can tell, it is never explicitly stated anywhere that this is a 2D-only code, even though in the paper it's compared to codes which support 3D simulations. That's a crucial piece of information for potential users and should be stated clearly. If a potential user needs to perform a 3D simulation, they obviously cannot use Mandyoc and should be directed elsewhere quickly, but otherwise a smaller and more contained (hence potentially easier to understand and modify) 2D-focused code might be just what they're looking for.

victorsacek commented 2 years ago

Dear @psanan You are correct. Now we explicitly say that Mandyoc is a 2-D code in the JOSS paper.

rbeucher commented 2 years ago

Looks OK to me. I am closing this.