Closed juliohm closed 4 years ago
Thank you so much for the important comments. I am already looking on it
@juliohm thank you for your insightful comments. It has helped me improve the paper up to the current state.
Linking to the review: https://github.com/openjournals/joss-reviews/issues/1912
@matbesancon @juliohm Thank you for the important and insightful comments about the software paper. I will appreciate if you mention any other issue that you think is necessary. But, we think that the current state of the paper explains to our goal.
@juliohm @matbesancon I would like to edit the introduction of the software paper. I have a short and to the point version of it but I don know if it is a good idea to change it now as am sure you are already reviewing it.
It's ok on my side if you edit the manuscript, don't forget to recompile so that we get the last version
On Thu, Dec 19, 2019, 15:50 Kipngeno Kirui notifications@github.com wrote:
@juliohm https://github.com/juliohm @matbesancon https://github.com/matbesancon I would like to edit the introduction of the software paper. I have a short and to the point version of it but I don know if it is a good idea to change it now as am sure you are already reviewing it.
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/kirui93/ScenTrees.jl/issues/13?email_source=notifications&email_token=AB2FDMVMGAOJCTCSN43NN63QZOC4HA5CNFSM4JTDDHO2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHJ2VVQ#issuecomment-567519958, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB2FDMVUFZ2FCCCSEJGYMZ3QZOC4HANCNFSM4JTDDHOQ .
Okay. I hope it is also okay for @juliohm.
Please go ahead. +1
On Thu, Dec 19, 2019, 12:30 Kipngeno Kirui notifications@github.com wrote:
Okay. I hope it is also okay for @juliohm https://github.com/juliohm.
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/kirui93/ScenTrees.jl/issues/13?email_source=notifications&email_token=AAZQW3OXGCVU7QV2SESCEMLQZOHPVA5CNFSM4JTDDHO2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHJ65LY#issuecomment-567537327, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAZQW3PDU5IZEADMKYPJNWLQZOHPVANCNFSM4JTDDHOQ .
@juliohm @matbesancon Thank you so much for your replies as well as your patience and also for the important reviews. I will update recompile immediately in the joss issue for you to get this version.
@juliohm @matbesancon It is now very ready.
Thank you @kirui93 for the update. The new draft of the paper looks much better. I am marking the issue as solved.
Below you can find some review comments on the software paper:
Introduction
Paragraph 1
It is the opposite direction: decision making under uncertainty leads to multistage optimization sometimes. Please adjust the text to reflect this direction.
It is not only in this setting, it is in general. Stochastic processes have random outcomes always. You could also eliminate the word uncertain since you are already using random.
This statement is too general. Many mathematical programs with uncertain parameters are tractable. You need to adjust the sentence to make it more smooth.
Common approach to what exactly? Please review this first paragraph as it is the most important of all paragraphs here. You need to show the usefulness of your package, and for that you need to understand very well the problem it is addressing, nothing more, nothing less.
This is the first sentence of the first paragraph that is simple to read, and to the point. Please review the entire paragraph based on the comments above to better set the ground for your package.
Paragraph 2
You need a connector here. When you write "Since...", you need to have a coma somewhere with the other sentence. In this case, you need ", various authors...". I would simply write: "various authors including ... did come up with various ideas for generating scenario trees."
I would rewrite it as "Still, an open-source implementation is missing, and researchers are forced to code their own versions..." Also, it is fine if people choose other languages, you shouldn't imply in the text that using different languages is bad.
The rest of the paragraph can be removed. It is redundant and the message was already conveyed with the previous sentence.
Paragraph 3
I would start the introduction here. Maybe just remove the previous paragraphs entirely? This paragraph and the remaining ones in the introduction are clear, to the point, and people in the area will quickly get it. With the previous paragraphs you risk loosing the reader.
Main features of the package
Paragraph 1
Rewrite it to "ScenTrees.jl is applicable to any type of stochastic process."
Rewrite it to "The key features of the package are:" Also move the implementation details and examples of usage to after the bullet points. They are breaking the flow of thought.
Example
The subsection should be called "Approximation with scenario tree".
Overall, I suggest you to use a English corrector online to fix the errors, and to organize the thoughts better. This can help improve the experience of readers by a lot. Hope you can address the comments above, the software paper needs some extra work.