GasChromatographyToolbox / GasChromatographySimulator.jl

A package for the simulation of gas chromatography (GC)
MIT License
11 stars 3 forks source link

JOSS: paper #46

Closed bonh closed 2 years ago

bonh commented 2 years ago

In reference to https://github.com/openjournals/joss-reviews/issues/4565.

I will post issues and questions about the paper here and hope that we can engage in a discussion about them.

bonh commented 2 years ago

Summary: There are a lot of brackets which makes it hard for me to follow. Are they really necessary at that stage?

Statement of need: I think some of the more practical parts in the summary might be better suited in the statement of need. Why gas chromatography? Why simulation of it? And I'm missing "who the target audience is, and its relation to other work".

bonh commented 2 years ago

And perhaps you could "mention (if applicable) a representative set of past or ongoing research projects using the software and recent scholarly publications enabled by it."

JanLeppert commented 2 years ago

Thank you for your comments. I agree with your notes and I will make some changes to the text in the next days. I also will make some small changes to the documentation due to some updates of the package.

bonh commented 2 years ago

I think you should "indicate whether related publications (published, in review, or nearing submission) exist as part of submitting to JOSS", see link above. In my opinion, the paper and this submission are both valuable but perhaps you would like to mention the paper more prominently in your JOSS paper (already in the summary?).

bonh commented 2 years ago

To produce the results of the paper http://10.0.3.248/j.chroma.2020.460985 did you use a predecessor or even an early version of GasChromatographySimulator.jl? If you did it might make sense to use that paper to provide validating results of your software. Otherwise you might want to add a plot to the JOSS paper indicating what kind of results including their accuracy one can expect from your software.

JanLeppert commented 2 years ago

In the paper was a predecessor used, written in Scilab (similar to Matlab). The fundamental models for fluidics and retention are the same. The Scilab version used a simpler approach to solve the ODE (in principal the Euler method), which toke much more time to run.

I started to implement two examples from this paper (one with conventional GC, one with thermal gradient) in the documentation (#55). I have thought about this earlier. I could than add a plot from these examples (e.g. comparison of measured and simulated chromatograms)

JanLeppert commented 2 years ago

In regards to related publications:

JanLeppert commented 2 years ago

With #59 I re-worked the draft of the paper.

I changed the order of paragraphs, moved some from section Summary to Statement of need.

I added a graph, where a measured chromatogram (taken from 10.1016/j.chroma.2020.460985) is compared with a simulation. Two comparisons are now part of the documentation in section Examples.

I added a paragraph about similar software (lines 55-60) and added another paragraph about related work/projects (line 61-65)