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]: GridapDistributed: a massively parallel finite element toolbox in Julia #4157

Closed
60 tasks done
whedon opened this issue Feb 13, 2022 · 107 comments
Closed
60 tasks done
Assignees
Labels
accepted Julia published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review Shell

Comments

@whedon
Copy link

whedon commented Feb 13, 2022

Submitting author: @amartinhuertas (Dr. Alberto F. Martin)
Repository: https://github.com/gridap/GridapDistributed.jl/
Branch with paper.md (empty if default branch): joss_paper
Version: v0.2.6
Editor: @Kevin-Mattheus-Moerman
Reviewers: @PetrKryslUCSD, @Leticia-maria, @jedbrown
Archive: 10.5281/zenodo.6622081

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

Status

status

Status badge code:

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

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

@PetrKryslUCSD & @Leticia-maria & @jedbrown, 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 @Kevin-Mattheus-Moerman 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

Review checklist for @PetrKryslUCSD

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

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 (@amartinhuertas) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

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: Does the paper have a section titled 'Statement of Need' that clearly states 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 @Leticia-maria

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

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 (@amartinhuertas) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

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: Does the paper have a section titled 'Statement of Need' that clearly states 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 @jedbrown

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

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 (@amartinhuertas) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

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: Does the paper have a section titled 'Statement of Need' that clearly states 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 Feb 13, 2022

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @PetrKryslUCSD, @Leticia-maria, @jedbrown it looks like you're currently assigned to review this paper 🎉.

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

⭐ 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 Feb 13, 2022

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.04 s (1178.8 files/s, 104503.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Julia                           30            547            154           2627
TOML                             4            110              1            459
Markdown                        12             97              0            226
YAML                             2              0              6            110
Bourne Shell                     1              1              3              3
-------------------------------------------------------------------------------
SUM:                            49            755            164           3425
-------------------------------------------------------------------------------


Statistical information for the repository '35bcbf2144fe0509a1393d8a' was
gathered on 2022/02/13.
No commited files with the specified extensions were found.

@whedon
Copy link
Author

whedon commented Feb 13, 2022

PDF failed to compile for issue #4157 with the following error:

 Can't find any papers to compile :-(

@Kevin-Mattheus-Moerman
Copy link
Member

@PetrKryslUCSD, @Leticia-maria, @jedbrown, @amartinhuertas this is where the review takes places. The reviewers may now start their review, guided by the check lists at the top of those issue.
Reviewers can provide feedback here or open dedicated issues on the projects repository and link to them here.

@jedbrown
Copy link
Member

@whedon generate pdf from branch joss_paper

@whedon
Copy link
Author

whedon commented Feb 13, 2022

Attempting PDF compilation from custom branch joss_paper. Reticulating splines etc...

@jedbrown
Copy link
Member

@whedon check references from branch joss_paper

@whedon
Copy link
Author

whedon commented Feb 13, 2022

Attempting to check references... from custom branch joss_paper

@whedon
Copy link
Author

whedon commented Feb 13, 2022

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1137/141000671 is OK
- 10.21105/JOSS.02520 is OK
- 10.1137/20M1328786 is OK
- 10.1007/978-3-030-23957-2 is OK
- 10.5194/GMD-6-2099-2013 is OK
- 10.1137/100791634 is OK
- 10.1006/JCPH.1996.0047 is OK
- 10.3402/TELLUSA.V56I5.14436 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Feb 13, 2022

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@Leticia-maria
Copy link

@whedon Should I send a PDF with my comments/reviews here?

@danielskatz
Copy link

👋 @Leticia-maria - @whedon is a bot, now in the processing of being replaced by @editorialbot. Your editor is @Kevin-Mattheus-Moerman, and he will be able to help you submit review comments,

@Kevin-Mattheus-Moerman
Copy link
Member

@Leticia-maria you can try to attach a file here perhaps or give your feedback here in comments. Alternatively, and for longer discussions or larger issues, you could also open issues on the software repository and link to them here.

If you do create comments here you could use - [ ] to have checkboxes for individual items.

@whedon
Copy link
Author

whedon commented Feb 27, 2022

👋 @Leticia-maria, please update us on how your review is going (this is an automated reminder).

@Kevin-Mattheus-Moerman
Copy link
Member

@arfon it looks like whedon still does the reminders. ☝️

@arfon
Copy link
Member

arfon commented Feb 28, 2022

@arfon it looks like whedon still does the reminders. ☝️

Yeah, that will stop being the case over the next ~2 weeks. Apologies for any confusion caused.

@Kevin-Mattheus-Moerman
Copy link
Member

@PetrKryslUCSD, @Leticia-maria, @jedbrown I am just checking in to see how things are going. Could you please provide an update on review progress? If you need more time that is okay too. Thanks again for your help!

@PetrKryslUCSD
Copy link

@whedon generate pdf from branch joss_paper

@editorialbot
Copy link
Collaborator

My name is now @editorialbot

@PetrKryslUCSD
Copy link

@editorialbot generate pdf from branch joss_paper

@editorialbot
Copy link
Collaborator

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@editorialbot commands

@PetrKryslUCSD
Copy link

@editorialbot generate pdf

@Kevin-Mattheus-Moerman
Copy link
Member

@openjournals/dev hmmm can you check what is going on here? ☝️

@xuanxu
Copy link
Member

xuanxu commented Jun 9, 2022

The code for a couple of figures with multiple images with the same caption was invalid. This PR changes it to use a single image with multiple panels and using valid syntax.

@Kevin-Mattheus-Moerman
Copy link
Member

@amartinhuertas can you check this ☝️

Thanks for your help @xuanxu!

@Kevin-Mattheus-Moerman
Copy link
Member

@xuanxu this does not explain the reference checking to behave differently though right? ☝️

@xuanxu
Copy link
Member

xuanxu commented Jun 9, 2022

@Kevin-Mattheus-Moerman Right. About the reference checking: it seems that the first time when trying to find suggestions for "MPI: A Message-Passing Interface Standard Version ..." the Crossref API failed to respond or errored. The second time probably it just responded with no suggestions.

@amartinhuertas
Copy link

@amartinhuertas can you check this point_up

I already accepted the PR. Thanks @xuanxu !

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1016/j.cpc.2022.108341 is OK
- 10.1137/141000671 is OK
- 10.21105/JOSS.02520 is OK
- 10.1137/20M1328786 is OK
- 10.1007/978-3-030-23957-2 is OK
- 10.5194/GMD-6-2099-2013 is OK
- 10.1137/100791634 is OK
- 10.1006/JCPH.1996.0047 is OK
- 10.3402/TELLUSA.V56I5.14436 is OK
- 10.48550/ARXIV.2203.04629 is OK
- 10.1016/j.camwa.2020.06.009 is OK
- 10.1515/jnum-2012-0013 is OK
- 10.1007/s11831-017-9244-1 is OK
- 10.1007/s00366-006-0049-3 is OK
- 10.1515/jnma-2021-0081 is OK
- 10.1145/1163641.1163644 is OK
- 10.1007/978-3-642-23099-8 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator

👋 @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof 👉 openjournals/joss-papers#3270

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#3270, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label Jun 9, 2022
@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot accept

@editorialbot
Copy link
Collaborator

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

@editorialbot
Copy link
Collaborator

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

@editorialbot
Copy link
Collaborator

🚨🚨🚨 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.04157 joss-papers#3271
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.04157
  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...

@editorialbot
Copy link
Collaborator

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

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

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

This is how it will look in your documentation:

DOI

We need your help!

The 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:

@Kevin-Mattheus-Moerman
Copy link
Member

Congratulations @amartinhuertas et al. 🎉 on your publication in JOSS!

@PetrKryslUCSD, @Leticia-maria, @jedbrown thank you so much for your review efforts!!!

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

No branches or pull requests

10 participants