search

openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
721 stars 38 forks source link

[REVIEW]: QuantEcon.py: A community based Python library for quantitative economics #5585

Closed editorialbot closed 9 months ago

editorialbot commented 1 year ago

Submitting author: !--author-handle-->@jstac<!--end-author-handle-- (John Stachurski) Repository: https://github.com/QuantEcon/QuantEcon.py Branch with paper.md (empty if default branch): joss_paper Version: 0.7.1 Editor: !--editor-->@sbenthall<!--end-editor-- Reviewers: @janosg, @mnwhite Archive: 10.5281/zenodo.10345102

Status

status

Status badge code:

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

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

@janosg & @mnwhite, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review. First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @sbenthall know.

✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨

Checklists

📝 Checklist for @janosg

📝 Checklist for @mnwhite

editorialbot commented 1 year ago

Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks.

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

@editorialbot commands

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

@editorialbot generate pdf
editorialbot commented 1 year ago 
Software report:

github.com/AlDanial/cloc v 1.88  T=0.25 s (939.2 files/s, 119069.2 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                         152           5877           9408          12165
Markdown                         5            209              0            736
DOS Batch                        2             31              1            218
TeX                              1             22              0            196
make                             2             32              7            169
YAML                             5             32             41            159
reStructuredText                66             76            315            143
TOML                             1              8              0             62
INI                              1              0              0              3
Bourne Shell                     1              3              4              2
-------------------------------------------------------------------------------
SUM:                           236           6290           9776          13853
-------------------------------------------------------------------------------

gitinspector failed to run statistical information for the repository
editorialbot commented 1 year ago

Wordcount for paper.md is 2221

editorialbot commented 1 year ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.11650/twjm/1500405875 is OK
- 10.1002/anac.200410015 is OK
- 10.1007/s10589-010-9329-3 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.1016/0165-1765(86)90168-0 is OK
- 10.2307/j.ctv14163jx.16 is OK

MISSING DOIs

- None

INVALID DOIs

- None
editorialbot commented 1 year ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

sbenthall commented 1 year ago

👋🏼 @jstac @janosg @mnwhite this is the review thread for the paper. All of our communications will happen here from now on.

As a reviewer, the first step is to create a checklist for your review by entering

@editorialbot generate my checklist

as the top of a new comment in this thread.

These checklists contain the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. The first comment in this thread also contains links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention openjournals/joss-reviews#5585 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for reviews to be completed within about 2-4 weeks. Please let me know if any of you require some more time. We can also use EditorialBot (our bot) to set automatic reminders if you know you'll be away for a known period of time.

Please feel free to ping me (@sbenthall) if you have any questions/concerns.

janosg commented 1 year ago

Review checklist for @janosg

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

mmcky commented 1 year ago

@janosg thank you for the issues and review. Greatly appreciated. I think I have now addressed both comments linked above. I have also opened this discussion to see if we can make improvements through a more direct example gallery. Currently examples are provided across our lecture series and in the QuantEcon.py documentation docstrings.

janosg commented 1 year ago

Thanks @mmcky. I added a suggestion to your discussion but that is not a prerequisite for acceptance.

quantecon.py is a great package and it was a pleasure to review it!

@sbenthall my review is complete.

sbenthall commented 1 year ago

Thank you @janosg !

sbenthall commented 1 year ago

Hello @mnwhite , this submission is still waiting for your review. Please let me know if you have any questions about the process.

mnwhite commented 1 year ago

Getting to this soon.

On Thu, Jul 20, 2023 at 12:29 PM Sebastian Benthall < @.***> wrote:

Hello @mnwhite https://github.com/mnwhite , this submission is still waiting for your review. Please let me know if you have any questions about the process.

— Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/5585#issuecomment-1644232410, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADKRAFMRKSEU4CHMH2AZLNTXRFMGFANCNFSM6AAAAAAZQ3VEAM . You are receiving this because you were mentioned.Message ID: @.***>

mnwhite commented 1 year ago

Review checklist for @mnwhite

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

arfon commented 1 year ago

@mnwhite – how are you getting on here. Do you think you might be able to complete your review in the next week or so?

mnwhite commented 1 year ago

Yes, my schedule has opened up quite a bit and I can now prioritize this.

On Sun, Oct 1, 2023, 2:51 AM Arfon Smith @.***> wrote:

@mnwhite https://github.com/mnwhite – how are you getting on here. Do you think you might be able to complete your review in the next week or so?

— Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/5585#issuecomment-1741981645, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADKRAFPMU5BOONNWAPZOADTX5EHIVANCNFSM6AAAAAAZQ3VEAM . You are receiving this because you were mentioned.Message ID: @.***>

jstac commented 1 year ago

@arfon @sbenthall Is there a target date for the first round referee process? Please let us know if we can help expedite by providing more information.

mnwhite commented 1 year ago

It was probably long ago. I am the holdup. I began working on my review, then got distracted, and now I have a newborn. I will try to get to this ASAP, I'm really sorry, John.

On Mon, Oct 30, 2023, 12:08 AM John Stachurski @.***> wrote:

@arfon https://github.com/arfon @sbenthall https://github.com/sbenthall Is there a target date for the first round referee process? Please let us know if we can help expedite by providing more information.

— Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/5585#issuecomment-1784446224, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADKRAFLTAZYC5JJMVP65JSTYB4R4TAVCNFSM6AAAAAAZQ3VEAOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTOOBUGQ2DMMRSGQ . You are receiving this because you were mentioned.Message ID: @.***>

jstac commented 1 year ago

No problem @mnwhite, I've been in your shoes and I remember what it was like. We're looking forward to your review when you're ready to submit.

jstac commented 11 months ago

@mnwhite Sorry to keep pinging you but it would help some of the young people listed as coauthors. Hopefully it won't take too long.

mnwhite commented 11 months ago

"You're hurting young economists" is my trigger. I will get this done tomorrow.

On Mon, Nov 20, 2023, 11:43 PM John Stachurski @.***> wrote:

@mnwhite https://github.com/mnwhite Sorry to keep pinging you but it would help some of the young people listed as coauthors. Hopefully it won't take too long.

— Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/5585#issuecomment-1820231840, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADKRAFIK5BMVV7SXQS63KRLYFQWN5AVCNFSM6AAAAAAZQ3VEAOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMRQGIZTCOBUGA . You are receiving this because you were mentioned.Message ID: @.***>

mnwhite commented 11 months ago

@jstac @sbenthall I finally, finally, finally got around to this. I am so sorry this took so long and kept slipping.

John: Are you in Canberra? If so, cookies (etc) will be sent to your office.

jstac commented 11 months ago

Thanks for your time @mnwhite No need for cookies --- I remember what it was like to have a new baby in the house. And lots of people are waiting on me for various tasks, so I would feel bad if everyone else was on time :)

mnwhite commented 11 months ago

Too late on the cookies / you can't stop me! It's too much for one person to eat anyway, so give to hungry students.

On Sat, Nov 25, 2023, 3:46 PM John Stachurski @.***> wrote:

Thanks for your time @mnwhite https://github.com/mnwhite No need for cookies --- I remember what it was like to have a new baby in the house. And lots of people are waiting on me for various tasks, so I would feel bad if everyone else was on time :)

— Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/5585#issuecomment-1826416760, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADKRAFORKQAIGMENDCKQX5DYGJKL3AVCNFSM6AAAAAAZQ3VEAOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMRWGQYTMNZWGA . You are receiving this because you were mentioned.Message ID: @.***>

jstac commented 11 months ago

Thanks @mnwhite :-) And thanks in advance from the hungry students.

jstac commented 11 months ago

Sweets and cookies have landed, and look amazing, thanks @mnwhite :-) You have made the hungry students (and admin staff) very happy.

mnwhite commented 11 months ago

Awesome, it was the least I could do after the long delay. Good luck to any of your students on the market!

On Sun, Nov 26, 2023, 7:54 PM John Stachurski @.***> wrote:

Sweets and cookies have landed, and look amazing, thanks @mnwhite https://github.com/mnwhite :-) You have made the hungry students (and admin staff) very happy.

— Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/5585#issuecomment-1826973267, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADKRAFKQGN5WKKRD23KFLWDYGPQEPAVCNFSM6AAAAAAZQ3VEAOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMRWHE3TGMRWG4 . You are receiving this because you were mentioned.Message ID: @.***>

sbenthall commented 11 months ago

Ok, this submission passes review! On to next steps...

@editorialbot create post-review checklist

sbenthall commented 11 months ago

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

Editor Tasks Prior to Acceptance

sbenthall commented 11 months ago

@editorialbot generate pdf

sbenthall commented 11 months ago

@editorialbot check references

editorialbot commented 11 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.11650/twjm/1500405875 is OK
- 10.1002/anac.200410015 is OK
- 10.1007/s10589-010-9329-3 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.1016/0165-1765(86)90168-0 is OK
- 10.2307/j.ctv14163jx.16 is OK

MISSING DOIs

- None

INVALID DOIs

- None
sbenthall commented 11 months ago

@editorialbot generate pdf

editorialbot commented 11 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

editorialbot commented 11 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

sbenthall commented 11 months ago

@jstac Could you please title-case your references by, for example, writing them out like so in the bibtex file:

An {E}xperimental {A}nalysis of {L}emke-{H}owson {A}lgorithm

In general, this is getting to be the last chance to make edits. I'll be doing a proof-reading pass this week. If you could double-check the items on the checklist, that would be great.

When this is finalized (should be by the end of the week!), the last steps are to tag a release, publish an archive online to get a DOI, and then we wrap up.

mnwhite commented 11 months ago

The article text had a very small number of grammatical / style mistakes, like a missing "the".

On Mon, Nov 27, 2023, 10:44 AM Sebastian Benthall @.***> wrote:

@jstac https://github.com/jstac Could you please title-case your references by, for example, writing them out like so in the bibtex file:

An {E}xperimental {A}nalysis of {L}emke-{H}owson {A}lgorithm

In general, this is getting to be the last chance to make edits. I'll be doing a proof-reading pass this week. If you could double-check the items on the checklist, that would be great.

When this is finalized (should be by the end of the week!), the last steps are to tag a release, publish an archive online to get a DOI, and then we wrap up.

— Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/5585#issuecomment-1828084922, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADKRAFN5YMW32232F3AKR3LYGSYOBAVCNFSM6AAAAAAZQ3VEAOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMRYGA4DIOJSGI . You are receiving this because you were mentioned.Message ID: @.***>

jstac commented 11 months ago

Thanks @sbenthall and @mnwhite . Our team will address these remaining issues ASAP. (CC @mmcky)

mmcky commented 11 months ago

Could you please title-case your references

Thanks @sbenthall I have just pushed updates to the bibtex file to add title-case.

mmcky commented 11 months ago

@editorialbot generate pdf

editorialbot commented 11 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

mmcky commented 11 months ago

thanks @sbenthall I have made some minor typo adjustments to the manuscript and edited the bibtex file.

re: bibtex file I changed the titles to title-case but did you want the curly braces as shown in the code-block?

An {E}xperimental {A}nalysis of {L}emke-{H}owson {A}lgorithm

I interpret those as the letters that needed to change in the bibtex file (rather than the syntax you'd like used -- but happy to update tomorrow if needed).

sbenthall commented 11 months ago

@editorialbot generate pdf

editorialbot commented 11 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

sbenthall commented 11 months ago

@mmcky The curly braces in BibTex are a signal to the renderer to use literal capitalization. Otherwise, it reverts those letters to lower case. In the rendered PDF, those letters are still lower case.

image

mmcky commented 11 months ago

@editorialbot generate pdf

editorialbot commented 11 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

mmcky commented 11 months ago

Thanks for explaining @sbenthall -- I have gone through and updated the bibtex file for forced title-case

Is this looking right?

Screenshot 2023-12-01 at 8 21 45 am
sbenthall commented 11 months ago

Yes, that's right. Thanks @mmcky

I've done a proofreading pass and haven't found any other issues with the text.

It looks like you have listed a CC-BY license on the paper, but the repository has an MIT license.

sbenthall commented 11 months ago

@editorialbot check references

editorialbot commented 11 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.11650/twjm/1500405875 is OK
- 10.1002/anac.200410015 is OK
- 10.1007/s10589-010-9329-3 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.1016/0165-1765(86)90168-0 is OK
- 10.2307/j.ctv14163jx.16 is OK

MISSING DOIs

- None

INVALID DOIs

- None