Hi, as part of the review that I am doing for JOSS openjournals/joss-reviews#10580 I have to evaluate the following point:
Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
I saw several examples (readme, documentation, and examples directory), and was able to run them, which is great!
The only issue that I have with them is that they are only code, which might not be easy for everyone to decipher. I couldn't find anywhere else than in the code what each example is supposed to illustrate. So, I think that it could be useful to add a concise introduction to each of them, describing in words and equations what problem is solved by this example. In this way, anyone will be able to understand the code by matching the textual+math description to the code.
Hi, as part of the review that I am doing for JOSS openjournals/joss-reviews#10580 I have to evaluate the following point:
I saw several examples (readme, documentation, and
examplesdirectory), and was able to run them, which is great!The only issue that I have with them is that they are only code, which might not be easy for everyone to decipher. I couldn't find anywhere else than in the code what each example is supposed to illustrate. So, I think that it could be useful to add a concise introduction to each of them, describing in words and equations what problem is solved by this example. In this way, anyone will be able to understand the code by matching the textual+math description to the code.