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

[REVIEW]: PyMarket #1591

Closed
whedon opened this issue Jul 23, 2019 · 81 comments
Closed

[REVIEW]: PyMarket #1591

whedon opened this issue Jul 23, 2019 · 81 comments
Assignees
Labels

Comments

@whedon
Copy link
Collaborator

@whedon whedon commented Jul 23, 2019

Submitting author: @gus0k (Diego)
Repository: https://github.com/gus0k/pymarket
Version: v0.7.8
Editor: @alexhanna
Reviewer: @igarizio, @taqtiqa-mark
Archive: 10.5281/zenodo.3665175

Status

status

Status badge code:

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

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) by leaving comments 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

@igarizio & @taqtiqa-mark, 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.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @alexhanna know.

Please try and complete your review in the next two weeks

Review checklist for @igarizio

Conflict of interest

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: v0.7.8
  • Authorship: Has the submitting author (@gus0k) 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 @taqtiqa-mark

Conflict of interest

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: v0.7.8
  • Authorship: Has the submitting author (@gus0k) 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

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Jul 23, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @igarizio, @taqtiqa-mark it looks like you're currently assigned to review 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:

watching

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

notifications

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

@whedon commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf
@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Jul 23, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Jul 23, 2019

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Jul 31, 2019

Hello,

Do you have anything so far that you would like me to fix or clarify?

Best regards,
K

@igarizio

This comment has been minimized.

Copy link

@igarizio igarizio commented Aug 5, 2019

Hello @gus0k 👋,
Great work on PyMarket! It is really well written and nicely documented. Also, the idea behind it seems really useful.

Here are some of my comments:

  • Software version: This may be silly, but I prefer to ask. The review states v0.7.4 but your last version is v0.7.5, I suppose you want to publish the last version, right? (@alexhanna if that is the case, is it possible to just change the version stated in this issue?)

  • Authorship: Just wanted to check, but you own both @gus0k and @ellguso, right? (context: I was looking at the contributors part of your repo)

  • Paper acknowledgement: Here I may be wrong, but I think the title "acknowledgement" may not be correct. What I generally see in the acknowledgement part is words of appreciation to other researchers, funding entities, etc. (@taqtiqa-mark, @alexhanna please let me know what you think).

  • List of mechanisms: I think it would help people reading your paper if you added a list of the mechanisms implemented in the library (maybe you can even add this list to your README).

  • Paper references: If you decide to add the list of mechanisms implemented, I think it would be appropriate to cite where those mechanisms come from (I think you already have those references inside huang_auction.py, muda_auction.py, etc.)

  • Small detail: On the second page of the paper, it says "Figure 1: png".

I will continue to review the other items in the checklist and will post if necessary. Please let me know if you have any questions. 😃

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Aug 8, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Aug 8, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Aug 8, 2019

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Aug 8, 2019

@whedon set v0.7.5 as version

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Aug 8, 2019

I'm sorry @gus0k, I'm afraid I can't do that. That's something only editors are allowed to do.

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Aug 8, 2019

@igarizio @taqtiqa-mark Thank you both so far for your input. I have updated the paper to list the implemented algorithms and their references.

@alexhanna Would it be possible to update the version number to 0.7.5?

Regarding the acknowledgements, Telecom ParisTech is paying for my PhD. In that sense, I feel it plays the same role as funding entities.

Best regards,
K

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Aug 28, 2019

@igarizio @taqtiqa-mark , can I help you in any way to advance in your reviews?
Best regards,
k

@alexhanna

This comment has been minimized.

Copy link

@alexhanna alexhanna commented Sep 1, 2019

👋 @igarizio and @taqtiqa-mark, are you able to continue your reviews of this package?

@alexhanna

This comment has been minimized.

Copy link

@alexhanna alexhanna commented Sep 1, 2019

@whedon set v0.7.5 as version

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Sep 1, 2019

OK. v0.7.5 is the version.

@alexhanna

This comment has been minimized.

Copy link

@alexhanna alexhanna commented Sep 1, 2019

@gus0k the version has been updated.

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Sep 10, 2019

Thank you.

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Sep 24, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Sep 24, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Sep 24, 2019

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Sep 24, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Sep 24, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Sep 24, 2019

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Sep 24, 2019

Hello,

What is the status on this?

Best regards,
Diego

@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Feb 12, 2020

@whedon check references

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

Reference check summary:

OK DOIs

- 10.1109/EEM.2017.7981938 is OK
- 10.1109/SmartGridComm.2017.8340728 is OK
- 10.1109/ISGT.2019.8791585 is OK
- 10.1111/1467-937X.00171 is OK
- 10.1111/1467-8640.t01-1-00206 is OK
- 10.1088/1469-7688/2/5/303 is OK
- 10.1088/1469-7688/1/2/307 is OK

MISSING DOIs

- None

INVALID DOIs

- None
@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Feb 12, 2020

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Feb 12, 2020

sorry, missed one in the bib - please merge gus0k/pymarket#20 as well

@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Feb 12, 2020

also, be aware that you can do @whedon generate pdf to check the PDF when you choose to

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Feb 12, 2020

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Feb 12, 2020

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Feb 12, 2020

@danielskatz
Created the tagged version (0.78) and uploaded it to zenodo:

10.5281/zenodo.3665175

@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Feb 12, 2020

@whedon set v0.7.8 as version

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

OK. v0.7.8 is the version.

@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Feb 12, 2020

@whedon set 10.5281/zenodo.3665175 as archive

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

OK. 10.5281/zenodo.3665175 is the archive.

@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Feb 12, 2020

Please change the metadata in the zenodo repository so that the title is the same as the title of the paper

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Feb 12, 2020

Done

@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Feb 12, 2020

@whedon accept

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

Attempting dry run of processing paper acceptance...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

Reference check summary:

OK DOIs

- 10.1109/EEM.2017.7981938 is OK
- 10.1109/SmartGridComm.2017.8340728 is OK
- 10.1109/ISGT.2019.8791585 is OK
- 10.1111/1467-937X.00171 is OK
- 10.1111/1467-8640.t01-1-00206 is OK
- 10.1088/1469-7688/2/5/303 is OK
- 10.1088/1469-7688/1/2/307 is OK

MISSING DOIs

- None

INVALID DOIs

- None
@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

Check final proof 👉 openjournals/joss-papers#1299

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#1299, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true
@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Feb 12, 2020

@whedon accept deposit=true

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

Doing it live! Attempting automated processing of paper acceptance...
@whedon whedon added the accepted label Feb 12, 2020
@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 openjournals/joss-papers#1300
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01591
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? notify your editorial technical team...

@danielskatz

This comment has been minimized.

Copy link

@danielskatz danielskatz commented Feb 12, 2020

Thanks to @igarizio & @taqtiqa-mark for reviewing!
And to @alexhanna for editing!

Congratulations to @gus0k and co-authors!

@whedon

This comment has been minimized.

Copy link
Collaborator Author

@whedon whedon commented Feb 12, 2020

🎉🎉🎉 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](https://joss.theoj.org/papers/10.21105/joss.01591/status.svg)](https://doi.org/10.21105/joss.01591)

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

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

This is how it will look in your documentation:

DOI

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:

@gus0k

This comment has been minimized.

Copy link

@gus0k gus0k commented Feb 12, 2020

Thank you all!

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

Successfully merging a pull request may close this issue.

None yet
8 participants
You can’t perform that action at this time.