Skip to content

[REVIEW]: ndsplines: A Python Library for Tensor-Product B-Splines of Arbitrary Dimension #1745

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

Closed
38 tasks done
whedon opened this issue Sep 18, 2019 · 51 comments
Closed
38 tasks done
Assignees
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@whedon
Copy link

whedon commented Sep 18, 2019

Submitting author: @sixpearls (Benjamin Margolis)
Repository: https://github.com/kb-press/ndsplines/
Version: 0.1.1
Editor: @mbobra
Reviewer: @amritagos, @sarats
Archive: 10.5281/zenodo.3516465

Status

status

Status badge code:

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

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

@amritagos & @sarats, 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 @mbobra know.

Please try and complete your review in the next two weeks

Review checklist for @amritagos

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?
  • Contribution and authorship: Has the submitting author (@sixpearls) 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 functionality 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

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

Review checklist for @sarats

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?
  • Contribution and authorship: Has the submitting author (@sixpearls) 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 functionality 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

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?
@whedon
Copy link
Author

whedon commented Sep 18, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @amritagos, @sarats 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
Copy link
Author

whedon commented Sep 18, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Sep 18, 2019

@amritagos
Copy link

@whedon check references

@whedon
Copy link
Author

whedon commented Sep 18, 2019

Attempting to check references...

@whedon
Copy link
Author

whedon commented Sep 18, 2019


OK DOIs

- 10.21105/joss.00396 is OK
- 10.1109/mcse.2011.37 is OK
- 10.1109/mcse.2010.118 is OK
- 10.1002/zamm.19800600129 is OK
- 10.2514/6.2019-2901 is OK
- 10.2514/6.2002-4482 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@mbobra
Copy link
Member

mbobra commented Sep 20, 2019

/ooo September 23 until September 27

@ooo
Copy link

ooo bot commented Sep 20, 2019

@sixpearls
Copy link

sixpearls commented Oct 4, 2019

Hi @amritagos, @sarats, how are the reviews going? Thanks for opening the issue about the license, @amritagos. We will likely wait to bulk process some of the smaller corrections like this one.

CC'ing my co-author, @ixjlyons

@amritagos
Copy link

Hi @sixpearls, I have completed my review and am waiting for the issue to be resolved for my closing comments. Great work!

@amritagos
Copy link

@mbobra, I have completed my review and am certain that the work presented by @sixpearls and @ixjlyons is well within the JOSS purview. The work is in accordance with the rules and standards of JOSS and I am glad to recommend this for acceptance and subsequent publication. Thanks!

@mbobra
Copy link
Member

mbobra commented Oct 7, 2019

Thank you, @amritagos!

@mbobra
Copy link
Member

mbobra commented Oct 7, 2019

@whedon remind @sarats in one hour

@whedon
Copy link
Author

whedon commented Oct 7, 2019

Reminder set for @sarats in one hour

@whedon
Copy link
Author

whedon commented Oct 7, 2019

👋 @sarats, please update us on how your review is going.

@sixpearls
Copy link

Thank you @amritagos!

@mbobra
Copy link
Member

mbobra commented Oct 14, 2019

@whedon remind @sarats in one hour

@whedon
Copy link
Author

whedon commented Oct 14, 2019

Reminder set for @sarats in one hour

@whedon
Copy link
Author

whedon commented Oct 14, 2019

👋 @sarats, please update us on how your review is going.

@sarats
Copy link

sarats commented Oct 15, 2019

Nice work, good to go.

Sorry for the delay. I was away from work last week.

@mbobra
Copy link
Member

mbobra commented Oct 15, 2019

Thank you, @sarats! (And congratulations!)

@mbobra
Copy link
Member

mbobra commented Oct 15, 2019

@sixpearls We're almost there! Can you please archive your release on Zenodo to obtain a DOI and then put that DOI in your readme.rst file? Please make sure that the title and author list on the Zenodo archive match the title and author list of the JOSS paper. After that I think we're done 🎉

@whedon
Copy link
Author

whedon commented Oct 23, 2019

Attempting to check references...

@whedon
Copy link
Author

whedon commented Oct 23, 2019


OK DOIs

- 10.21105/joss.00396 is OK
- 10.1109/mcse.2011.37 is OK
- 10.1109/mcse.2010.118 is OK
- 10.1002/zamm.19800600129 is OK
- 10.2514/6.2019-2901 is OK
- 10.2514/6.2002-4482 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@mbobra
Copy link
Member

mbobra commented Oct 23, 2019

@whedon set 10.5281/zenodo.3516465 as archive

@whedon
Copy link
Author

whedon commented Oct 23, 2019

OK. 10.5281/zenodo.3516465 is the archive.

@mbobra
Copy link
Member

mbobra commented Oct 23, 2019

@whedon set 0.1.1 as version

@whedon
Copy link
Author

whedon commented Oct 23, 2019

OK. 0.1.1 is the version.

@mbobra
Copy link
Member

mbobra commented Oct 23, 2019

@openjournals/joss-eics This paper is ready for acceptance! Nice work @sixpearls @ixjlyons 🎉

@kthyng
Copy link

kthyng commented Oct 24, 2019

Hi @sixpearls! It looks like the citations in your paper aren't working when you have more than one because you are using commas to separate multiple references — please update to use semicolons. Also, please go through your references file and use {} around any words that need to stay capitalized, like MATLAB. The {} preserve capitalization.

@sixpearls
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Oct 25, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Oct 25, 2019

@sixpearls
Copy link

Hi @kthyng, thank you for catching that. My co-author @ixjlyons has made those corrections and it looks correct now. Let us know if there are any other corrections.

@kthyng
Copy link

kthyng commented Oct 25, 2019

Great! Sorry I didn't realize to mention both @sixpearls and @ixjlyons.

The paper is looking good!

@kthyng
Copy link

kthyng commented Oct 25, 2019

@whedon accept

@whedon
Copy link
Author

whedon commented Oct 25, 2019

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented Oct 25, 2019


OK DOIs

- 10.21105/joss.00396 is OK
- 10.1109/mcse.2011.37 is OK
- 10.1109/mcse.2010.118 is OK
- 10.1002/zamm.19800600129 is OK
- 10.2514/6.2019-2901 is OK
- 10.2514/6.2002-4482 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Oct 25, 2019

Check final proof 👉 openjournals/joss-papers#1053

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

@whedon accept deposit=true

@kthyng
Copy link

kthyng commented Oct 25, 2019

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Oct 25, 2019

Doing it live! Attempting automated processing of paper acceptance...

@whedon
Copy link
Author

whedon commented Oct 25, 2019

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

@whedon
Copy link
Author

whedon commented Oct 25, 2019

🚨🚨🚨 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 👉 Creating pull request for 10.21105.joss.01745 joss-papers#1054
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01745
  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...

@kthyng
Copy link

kthyng commented Oct 25, 2019

Congrats @sixpearls and @ixjlyons on your new paper!! 🎉 🎉

Thanks very much to @amritagos and @sarats for your time and expertise as reviewers, and thanks to @mbobra for editing.

@kthyng kthyng closed this as completed Oct 25, 2019
@whedon
Copy link
Author

whedon commented Oct 25, 2019

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

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

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

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review
Projects
None yet
Development

No branches or pull requests

7 participants