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]: NodeLab: A MATLAB package for meshfree node-generation and adaptive refinement #1173

Closed
whedon opened this issue Jan 14, 2019 · 109 comments

Comments

@whedon
Copy link
Collaborator

commented Jan 14, 2019

Submitting author: @pankajkmishra (Pankaj K Mishra)
Repository: https://github.com/pankajkmishra/NodeLab
Version: v1.0
Editor: @kyleniemeyer
Reviewer: @Kevin-Mattheus-Moerman, @vijaysm
Archive: 10.5281/zenodo.3361734

Status

status

Status badge code:

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

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

@Kevin-Mattheus-Moerman & @vijaysm, 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 @kyleniemeyer know.

Please try and complete your review in the next two weeks

Review checklist for @Kevin-Mattheus-Moerman

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: Does the release version given match the GitHub release (v1.0)?
  • Authorship: Has the submitting author (@pankajkmishra) 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 @vijaysm

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: Does the release version given match the GitHub release (v1.0)?
  • Authorship: Has the submitting author (@pankajkmishra) 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

commented Jan 14, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @Kevin-Mattheus-Moerman, 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:

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
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Jan 14, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Jan 14, 2019

@kyleniemeyer

This comment has been minimized.

Copy link

commented Jan 14, 2019

👋 @pankajkmishra @Kevin-Mattheus-Moerman @vijaysm the actual review takes place in this issue. Please note the two separate review checklists above.

@pankajkmishra

This comment has been minimized.

Copy link

commented Jan 29, 2019

@whedon commands

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Jan 29, 2019

Here are some things you can ask me to do:

# List Whedon's capabilities
@whedon commands

# List of editor GitHub usernames
@whedon list editors

# List of reviewers together with programming language preferences and domain expertise
@whedon list reviewers

EDITORIAL TASKS

# Compile the paper
@whedon generate pdf

# Ask Whedon to check the references for missing DOIs
@whedon check references

@pankajkmishra

This comment has been minimized.

Copy link

commented Jan 29, 2019

@kyleniemeyer: Is there anything required from my side at this point?

@kyleniemeyer

This comment has been minimized.

Copy link

commented Jan 29, 2019

@pankajkmishra not at the moment—the reviewers will report any issues requiring your attention here or in the software repository as appropriate.

@vijaysm

This comment has been minimized.

Copy link
Collaborator

commented Jan 31, 2019

I should be able to complete the full review by next Monday. It has been a busy couple of weeks. @pankajkmishra @kyleniemeyer

@pankajkmishra

This comment has been minimized.

Copy link

commented Feb 18, 2019

@@kyleniemeyer: Is it allowed to update the repository while it is under review?

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

commented Feb 18, 2019

I'll finalize the review by next Monday. Apologies for the delay.

@kyleniemeyer

This comment has been minimized.

Copy link

commented Feb 19, 2019

@pankajkmishra Yes, but please let us know here when you update it and what changes were made; it sounds like the reviewers may not have started with the current version, so should be fine.

@vijaysm

This comment has been minimized.

Copy link
Collaborator

commented Feb 26, 2019

@kyleniemeyer Should I upload a list of my suggestions separately or just continue discussion with the author here as part of the comment thread ?

@pankajkmishra I also noticed that there is no official release for NodeLab yet. So it may be appropriate to update the versioning info first and then tag the commit as a checkpoint for the review. Thoughts @kyleniemeyer ?

@kyleniemeyer

This comment has been minimized.

Copy link

commented Feb 26, 2019

@vijaysm feel free to continue the discussion here; you can submit a list of suggestions as a single comment and we can go from there.

Regarding the official release, I'm fine if @pankajkmishra waits until after making any changes as part of this review process, and then makes an official release associated with the version accepted here.

@pankajkmishra

This comment has been minimized.

Copy link

commented Feb 27, 2019

Thanks @vijaysm! I'll look forward to your suggestions. @kyleniemeyer - That would be convenient! Thanks.

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

commented Mar 7, 2019

@pankajkmishra Here are some comments on the paper:

  • Add "be" in the following: "....(Persson & Strang, 2004), which can [be] computed based on a..."

  • Remove plural in: "As a results, NodeLab can take the following..."

  • Rephrase "some discrete set of point cloud on the boundary, which need not to be uniformly
    sampled." e.g. to: "some discrete set of point cloud on the boundary, which need not to be uniformly
    sampled."

  • Can you work to rephrase/clarify this awkward sounding sentence: "The boundary can be smoothed through curve-interpolation according to the fill-distance near the boundary, which provides the flexibility to create the domain by manually digitizing of the geometry from a hand-drawing, digital-drawing, or a downloaded image."

  • Can you add a References heading?

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

commented Mar 7, 2019

@whedon check references

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Mar 7, 2019

Attempting to check references...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Mar 7, 2019


OK DOIs

- None

MISSING DOIs

- https://doi.org/10.1016/j.camwa.2015.01.009 may be missing for title: Fast generation of 2-D node distributions for mesh-free PDE discretizations
- https://doi.org/10.1137/s0036144503429121 may be missing for title: A simple mesh generator in MATLAB

INVALID DOIs

- None
@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

commented Mar 7, 2019

I've created a pull request (pankajkmishra/NodeLab#2) to enhance the demos/documentation. I recommend clarifying the required input arguments and perhaps to visualize them as I suggest.
I also recommend making use of the MATLAB documentation generation tools. I give an example in that demo. You can publish it to create HTML documentation which can be integrated in MATLAB.

@pankajkmishra

This comment has been minimized.

Copy link

commented Mar 8, 2019

Thanks @Kevin-Mattheus-Moerman! I'll get back to you after implementing your suggestions.

@pankajkmishra

This comment has been minimized.

Copy link

commented Mar 8, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Mar 8, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Mar 8, 2019

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

commented Mar 8, 2019

@pankajkmishra great. Can you also work on adding those DOI's? Let me know if you have questions.

@pankajkmishra

This comment has been minimized.

Copy link

commented Mar 8, 2019

@whedon check references

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Mar 8, 2019

Attempting to check references...
@pankajkmishra

This comment has been minimized.

Copy link

commented Aug 2, 2019

@kyleniemeyer I have updated the paper showing better a clarity for the value addition.
Added the statistics toolbox dependency as @vijaysm had suggested. However, I couldn't make a similar 3D extension of it at the moment and it continues to be in the future work section. If the present form of the repository does not qualify to be listed in JOSS, I would be happy to withdraw the submission :)
P.S. I have a paper under review where I need to cite this work, which was the original purpose of submitting this to the JOSS.

@kyleniemeyer

This comment has been minimized.

Copy link

commented Aug 2, 2019

Thanks @pankajkmishra.

@vijaysm, do you recommend acceptance based on the changes made?

@vijaysm

This comment has been minimized.

Copy link
Collaborator

commented Aug 4, 2019

@pankajkmishra Thanks for the description update.

@kyleniemeyer While the updated paper makes the application space clearer than before, I would like to reiterate that the work on NodeLab still remains incremental. Node generation support for 3-D volumes or surfaces would certainly compel me to accept the paper. Also, other open-source Matlab packages by Per-Olof Persson (Distmesh [1]) and by Darren Engwirda (Mesh2D [2]), already do provide adaptive node generation and delaunay triangulation based on user-defined distance functions as well for 2-D domains. Additionally, I think some NodeLab examples showing adaptive refinement with integration to a mesh-free solver would have added value to this contribution with a practical use-case.

As it stands, I am taking the decision to reject the paper submission. @pankajkmishra, please consider updating examples and adding support for 3-D domains to differentiate this work from other existing open-source alternatives. I would be happy to discuss my comments further if you have any questions.

[1] http://persson.berkeley.edu/distmesh/
[2] https://github.com/dengwirda/mesh2d

@kyleniemeyer

This comment has been minimized.

Copy link

commented Aug 4, 2019

Hi @vijaysm, thanks for your input.

I should point out that JOSS does not reject submissions for novelty, originality, or impact; instead, we only reject when the authors are unwilling to improve the software to meet our standards. Since both you and @Kevin-Mattheus-Moerman have checked off all the review items, and it doesn't seem like there are any remaining items of that nature, I am going to move this into the final acceptance stages.

@pankajkmishra at this point please archive the software repository (e.g., in Zenodo) and provide the DOI here. I'm going to do a final review/edit of the paper itself.

@vijaysm

This comment has been minimized.

Copy link
Collaborator

commented Aug 4, 2019

@kyleniemeyer Fair enough. In that case, the description update from @pankajkmishra was all that was needed to make the submission complete for me.

@pankajkmishra

This comment has been minimized.

Copy link

commented Aug 6, 2019

Hey @kyleniemeyer , thanks! I'll do it ASAP.
Thank you @vijaysm @Kevin-Mattheus-Moerman for your valuable inputs.

@pankajkmishra

This comment has been minimized.

Copy link

commented Aug 6, 2019

@kyleniemeyer following is the Zenodo DOI
10.5281/zenodo.3361734

@kyleniemeyer

This comment has been minimized.

Copy link

commented Aug 12, 2019

@whedon set 10.5281/zenodo.3361734 as archive

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 12, 2019

OK. 10.5281/zenodo.3361734 is the archive.

@kyleniemeyer

This comment has been minimized.

Copy link

commented Aug 12, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 12, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 12, 2019

@kyleniemeyer

This comment has been minimized.

Copy link

commented Aug 12, 2019

Hi @pankajkmishra , just a few final edits needed on the paper:

  • can you provide more-complete affiliation info, like what you'd typically see in a journal article? (i.e., city, country)
  • Please merge my PR for fixes to the bib file: pankajkmishra/NodeLab#4
  • I did some copy editing to the paper in pankajkmishra/NodeLab#5, please merge that.

There are a few more places in the paper that should be edited:

The literature in this context is up-and-coming, which focus on different aspects of node-generation based on typical requirements. The node-placing approach by @Fornberg:2015 is similar to advancing front methods and has been reported to have advantages like computational speed, simple algorithms, and good quality of distribution.

  • The first sentence here doesn't make sense to me—I'm not sure what it's actually saying.
  • Anytime you reference "literature", it should be followed by multiple citations. Also, what are the "typical requirements"?
  • You mention "advancing front methods", but provide no definition or citation. Why is the fact that the node-placing approach is similar to these methods meaningful?

Aside from that, the first paragraph should start with a statement of need, meant for a general reader. I think you could move your sentence about the applications here, and do some revision to make it work.

@pankajkmishra

This comment has been minimized.

Copy link

commented Aug 15, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 15, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 15, 2019

@kyleniemeyer

This comment has been minimized.

Copy link

commented Aug 15, 2019

@kyleniemeyer

This comment has been minimized.

Copy link

commented Aug 15, 2019

@openjournals/joss-eics ok, this is ready for acceptance from my point of view

@pankajkmishra

This comment has been minimized.

Copy link

commented Aug 15, 2019

Thanks @kyleniemeyer , and everyone :)

@danielskatz

This comment has been minimized.

Copy link

commented Aug 15, 2019

@whedon accept

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 15, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 15, 2019

Check final proof 👉 openjournals/joss-papers#903

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#903, 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

commented Aug 15, 2019

Thanks to @Kevin-Mattheus-Moerman and @vijaysm for reviewing and @kyleniemeyer for editing

@danielskatz

This comment has been minimized.

Copy link

commented Aug 15, 2019

@whedon accept deposit=true

@whedon whedon added the accepted label Aug 15, 2019

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 15, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 15, 2019

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

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 15, 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 👉 openjournals/joss-papers#904
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01173
  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...

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 15, 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.01173/status.svg)](https://doi.org/10.21105/joss.01173)

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

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

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
Projects
None yet
8 participants
You can’t perform that action at this time.