Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[JOSS Review] Reproducibility and functionality #1

Closed
mbarzegary opened this issue Nov 16, 2022 · 4 comments
Closed

[JOSS Review] Reproducibility and functionality #1

mbarzegary opened this issue Nov 16, 2022 · 4 comments

Comments

@mbarzegary
Copy link

Dear author,

Generally speaking, the library works as described in the readme file of the repo, and the examples can be set up by following the instruction. However, there are minor fixes that can improve the quality of the submission:

  • gnuplot is needed to run example1 and generate the output. The instruction for building/running the example can be briefly mentioned in a readme file (similar to mentioning the requirement of BGL for the mithril example). The same thing applies to example 2.
  • The mithril example compiles and runs, but there is no output written to the file evolution.dat after 15 minutes. Maybe you need to mention any estimation of the time needed.
  • The evanstar example is difficult to evaluate. I think some sample output showing the results the user will get in the end can help to understand what this example tries to do (like the ones presented for the benchmark examples).

P.S. This issue is related to openjournals/joss-reviews#4902

@ttarkowski
Copy link
Owner

ttarkowski commented Nov 22, 2022

Thank you very much for your feedback! The relevant README file for example_1 was created.

@ttarkowski
Copy link
Owner

ttarkowski commented Nov 22, 2022

The relevant README file for example_2 was created too.

@ttarkowski
Copy link
Owner

Information about program execution time was added to the README file of mithril example.

@ttarkowski
Copy link
Owner

Example output was added to the evenstar example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants