[REVIEW]: Nashpy: A Python library for the computation of Nash equilibria

[whedon]

Submitting author: @drvinceknight (Vincent Knight)
Repository: https://github.com/drvinceknight/Nashpy
Version: v0.0.18
Editor: @labarba
Reviewer: @Fil, @alex-konovalov
Archive: 10.5281/zenodo.1453761

Status

Status badge code:

HTML: <a href="http://joss.theoj.org/papers/3ada2a699914888658b7ac9c12d20e03"><img src="http://joss.theoj.org/papers/3ada2a699914888658b7ac9c12d20e03/status.svg"></a>
Markdown: [![status](http://joss.theoj.org/papers/3ada2a699914888658b7ac9c12d20e03/status.svg)](http://joss.theoj.org/papers/3ada2a699914888658b7ac9c12d20e03)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@Fil & @alex-konovalov, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

1. Make sure you're logged in to your GitHub account
2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @labarba know.

✨ Please try and complete your review in the next two weeks ✨

Review checklist for @Fil

Conflict of interest

• As the reviewer I confirm that I have read the JOSS conflict of interest policy and that there are no conflicts of interest for me to review this work.

Code of Conduct

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the repository url?
• License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• Version: Does the release version given match the GitHub release (v0.0.18)?
• Authorship: Has the submitting author (@drvinceknight) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

• Installation: Does installation proceed as outlined in the documentation?
• Functionality: Have the functional claims of the software been confirmed?
• Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
• Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
• Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
• Automated tests: Are there automated tests or manual steps described so that the function of the software can be verified?
• Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

• Authors: Does the paper.md file include a list of authors with their affiliations?
• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

Review checklist for @alex-konovalov

Conflict of interest

• As the reviewer I confirm that I have read the JOSS conflict of interest policy and that there are no conflicts of interest for me to review this work.

Code of Conduct

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the repository url?
• License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• Version: Does the release version given match the GitHub release (v0.0.18)?
• Authorship: Has the submitting author (@drvinceknight) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

• Installation: Does installation proceed as outlined in the documentation?
• Functionality: Have the functional claims of the software been confirmed?
• Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
• Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
• Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
• Automated tests: Are there automated tests or manual steps described so that the function of the software can be verified?
• Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

• Authors: Does the paper.md file include a list of authors with their affiliations?
• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

[whedon]

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @Fil, it looks like you're currently assigned as the reviewer for this paper 🎉.

⭐ Important ⭐

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

2. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

For a list of things I can do to help you, just type:

@whedon commands

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

--> Check article proof 📄 <--

[labarba]

👋 @Fil, @alex-konovalov — This is where the action happens. Feel free to ask any questions.

[drvinceknight]

On drvinceknight/Nashpy#45 @Fil pointed out that the version specified in the paper meta data (v0.0.14) no longer matches the latest version of the library (since submitting I have updated the library a few times).

Should I edit the first comment to change the version number (v0.0.14 -> v0.0.17) or perhaps this can wait until the end of the review process when I assume the comment needs to be edited to point at an archived version?

[Fil]

Apart from the version issue, it's all good for me. Thank you @drvinceknight for submitting to JOSS.

[labarba]

I've updated the version number in the review issue.

[labarba]

👋 @alex-konovalov — will you be able to submit your review soon? Let me know!

[olexandr-konovalov]

@labarba sorry for delay - should be there by Monday!

[olexandr-konovalov]

@labarba review completed. Fixed two typos in drvinceknight/Nashpy#50 and pointed out a couple of issues with DOIs at drvinceknight/Nashpy#51. Otherwise, straightforward installation, proper testing and detailed documentation - @drvinceknight, thank you for submitting to JOSS!

[drvinceknight]

Thanks @alex-konovalov for your time (I believe I have fixed the issues you pointed out) and thanks again @Fil as well.

@labarba please let me know if I can do anything further at this stage.

[labarba]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

👉 Check article proof 📄 👈

[labarba]

Small editorial fixes:

1. paragraph 3: "beats Rock (the first action." ... close parenthesis.
2. paragraph 5: "computing this equilibria" ... these equilibria? or this equilibrium? Same sentence: check commas; something isn't quite right.
3. page 2: "easily accessibly" ... accessible
4. p. 2, par. 2: capitalize "python" ... also, check verb: "includes ... to its core C functionality" (adds?) ... and commas.
5. par. 3: numpy > NumPy; scipy> SciPy; also, maybe use em-dashes to avoid the double parenthesis due to the citation.
6. For example Windows > add comma
7. par. 4: 2 player games > 2-player games (add hyphen)
8. par. 5: avoid syntactic expletive in "There are potential limitations ... , these are due to" > "Potential limitations of Nashpy are due to the complexity..."
9. "potential pairs of strategy" > a strategy?
10. "For n x n sized square matrices" > delete "sized"
11. "it has complexity of the order of O(2^n^2)" > it has O(.) complexity" (the big-O already means "order of")
12. numpy > NumPy
13. "are generators which ensures" ... comma before "which"
14. "For example, below an 11 by 11 game" > "For example, below, an 11-by-11 game" (comma and hyphens)
15. "and timings computed are shown" > "and timings are shown"
16. "Using the ... (ref) an equilibrium..." > comma after (ref)
17. "it is already currently" > delete "already"?
18. "final year course" > "final-year course" (hyphen)
19. "read and understand implementation of the algorithms" > the implementation
20. awkward: "with the linked DOI: (ref)" ... maybe just remove "with the linked DOI" and simply put the ref.

[labarba]

Also, DOI links in the reference list are broken. Please clean up the bib file so the links resolve.

[drvinceknight]

Thanks @labarba I'll make those changes over next couple of days.

[labarba]

OK. Ping when done!

[drvinceknight]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

👉 Check article proof 📄 👈

[drvinceknight]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

👉 Check article proof 📄 👈

[drvinceknight]

@whedon generate pdf

[whedon]

👉 Check article proof 📄 👈

[drvinceknight]

@labarba thank you very much for taking the time to point all those out. I've made all the changes (drvinceknight/Nashpy@67a27f3) and checked the proof. I believe it's all done now :)

[labarba]

I bring you more editorial fixes!

Page 1, par. 2: comma before “which”
par. 3 “For example A_21” …add comma. “Using Nashpy the equilibrium” …add comma.
Statement of Need: “an example of this includes” >> “an example is”
Page 2.
Ref to Jones, Oliphant et al. appears with years marked as 2001–2001– … can you fix this?
On the same line, remove spaces before and after the em-dashes (that’s the norm).
par. 5: “Nashpy” here is formatted differently than elsewhere—pick one: code or non-code font?
Jones et al. again appears with that strange year range. Can you fix?

[drvinceknight]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

👉 Check article proof 📄 👈

[drvinceknight]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

👉 Check article proof 📄 👈

[drvinceknight]

Thanks again @labarba, I believe drvinceknight/Nashpy@af30119 gets all these. If there's anything else let me know.

I appreciate you taking the time. :)

[labarba]

OK! Go ahead and make a deposit on Zenodo now (or your favorite archival repository) and do post the DOI here.

[drvinceknight]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

👉 Check article proof 📄 👈

[drvinceknight]

Thank you @labarba, here is the zenodo archive: https://zenodo.org/record/1453761

DOI: 10.5281/zenodo.1453761

Let me know if I need to do anything further (and thanks again for all your time).

[labarba]

The author list on the Zenodo entry does not match the author list on the paper. You may need to manually edit the author list on Zenodo (which grabs that automatically from commit history, I think.)

[drvinceknight]

@labarba: that's been updated now.

[labarba]

👋 @arfon — this paper is accepted and ready to be published.

Many thanks to @Fil and @alex-konovalov for reviewing for JOSS. Without your efforts, this adventure in new-wave publishing would not be possible!

[arfon]

@whedon set 10.5281/zenodo.1453761 as archive

[whedon]

OK. 10.5281/zenodo.1453761 is the archive.

[arfon]

@drvinceknight - can you confirm that this maths looks OK? @whedon is giving me a warning when compiling the paper 10.21105.joss.00904.pdf

[WARNING] Could not convert TeX math '
  A=
  \begin{pmatrix}
  0  & -1 & 1  \\
  1  & 0  & -1 \\
  -1 & 1  & 0  \\
  \end{pmatrix}
  ', rendering as TeX```

[drvinceknight]

@drvinceknight - can you confirm that this maths looks OK?

@arfon I confirm that that looks right. (I'd suggest that it looks like the compiler is just raising a warning before falling "up" to use a superset compiler with the amsmath library.)

[arfon]

@Fil, @alex-konovalov - many thanks for your reviews here and to @labarba for editing this submission ✨

@drvinceknight - your paper is now accepted into JOSS and your DOI is https://doi.org/10.21105/joss.00904 ⚡ 🚀 💥

[whedon]

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](http://joss.theoj.org/papers/10.21105/joss.00904/status.svg)](https://doi.org/10.21105/joss.00904)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.00904">
  <img src="http://joss.theoj.org/papers/10.21105/joss.00904/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: http://joss.theoj.org/papers/10.21105/joss.00904/status.svg
   :target: https://doi.org/10.21105/joss.00904

This is how it will look in your documentation:

We need your help!

Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

• Volunteering to review for us sometime in the future. You can add your name to the reviewer list here: http://joss.theoj.org/reviewer-signup.html
• Making a small donation to support our running costs here: https://www.flipcause.com/secure/cause_pdetails/Mjk3Nzk=

[drvinceknight]

Thank you all once again for your time and effort. Having reviewed a few times it's been a pleasure to be on the other side. @arfon @labarba et al. well done for what you're doing here, this "new-wave publishing" is really enthusing.