-
-
Notifications
You must be signed in to change notification settings - Fork 39
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]: NOMAD: A distributed web-based platform for managing materials science research data #5388
Comments
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:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
|
Wordcount for |
|
Failed to discover a valid open source license |
Hi @arosen93, @berquist, @sgbaird - thanks for helping out reviewing this package. Please generate the checklists using
We aim for reviews to be completed within about 2-4 weeks, but please do 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. |
Review checklist for @sgbairdI'm adding some comments here for my own convenience. Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
Perhaps the bulleted lists of key features from https://nomad-lab.eu/nomad-lab/ (see image above) could be incorporated as three separate lists in the software paper. |
Review checklist for @berquistConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Hi @sgbaird @berquist and @arosen93 how is going reviewing the package? BTW @sgbaird @berquist if you have comments on the package please also open issues on their GitHub page and mention this issues ticket, so they are linked together. |
Thanks for the ping! I have it on my schedule to dig deeper into the code + paper this week :) Thanks for the patience, everyone! |
I've read the paper and believe that NOMAD belongs in JOSS. I'm still distilling my notes on the (website) documentation and haven't tried installing/testing/running other than building the Docker image. My current concerns are about the author list. How do I raise those concerns? |
👍
You can raise any concern here in this issue ticket. Note, that JOSS does allow authors other than the code contributors in the list. |
I have it on my calendar and plan to finish my review by May 25 (graduation, moving, new job playing into it). |
@zhubonan --- can you help with having @editorialbot make me a checklist? |
Just type
Then press the "Comment" button. This should be able to trigger the editorial bot to generate one for you. |
Review checklist for @arosen93Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@markus1978 and @zhubonan: OverviewI have finished my review of the code and paper. Overall, it is clear that the NOMAD code is well suited for JOSS and will be of significant interest to the computational materials science community at large. I am personally very excited about the code and am looking forward to use it in my work. I have no comments about the paper, which is clearly written. In terms of the checklist items, I have checked off most of them (see below for further details). However, I still think there are a few things that are worth improving on prior to acceptance of this work in JOSS. In general, there is a ton of code, and from a user or contributor standpoint, it's not immediately clear where to look for what in many cases. That accessibility for new users/contributors is the area that I think can be improved the most. It would be a shame if this enormous amount of work didn't end up being adopted outside the inner NOMAD sphere of users simply because of its scale. DocumentationNavigating the CodebaseOverall, I find the codebase to be a bit challenging to navigate. There is the main API DocumentationThe documentation for NOMAD itself is very clear, but I was left with many questions about how to use the
In general, I feel like there is a ton of code here but only a small fraction of it is made accessible to the user (especially prospective developers or code contributors) unless I am missing a section of the documentation. Installation and DependenciesSplitting up the DependenciesFrom a usability standpoint, it's very difficult to incorporate the NOMAD suite into existing codebases due to the large number of dependencies, several of which are not necessarily actively maintained (and therefore will likely become increasingly difficult to incorporat with newer versions of Python and secondary dependencies). In particular, I can see many use cases where someone might want to use the parsing features of NOMAD but aren't necessarily looking to parse every plausible code supported by NOMAD. In this case, it would be nice to be able to install only the Installation WoesOn the topic of dependencies, although I checked of "Does installation proceed as outlined," that is only strictly true once the issue I raised (nomad-coe/nomad#63) is resolved. Unit TestsFor DevelopersThere are unit tests that are run on the GitLab mirror, but they aren't run on the GitHub repo where users can contribute PRs. So, from a contributor perspective, it's not clear from the README or documentation how to run the unit tests locally to test out code. Having to rely on monitoring the GitLab repo for test failures is a bit cumbersome for the user. Since I see a |
Just started tonight. I should have mine within a couple days. I already thought highly of NOMAD, and I'm more impressed as I learn more. Looking forward to this! |
@arosen93 Thank you very much for taking the time to review NOMAD and for all the very helpful feedback. We are already getting loads of ideas from this on how to improve the addressed points. I will reply with a longer response and an overview about how we are tackling these points, once all the reviews are in. |
Done! version is now v1.2.1 |
@zhubonan thanks for editing here. Note for the future, the repository version tag should be fully matched and is here |
@markus1978 I am the AEiC for this track and here to help process final steps. I have check this review, the repository, the archive link and the paper. Most seems in order but below are some minor points that needs your attention:
|
Ah I see. @markus1978 could you please update the zenodo version tag? Should be able to do so without reupload I think. |
|
@zhubonan sorry I meant to tag @markus1978. We'll wait for the authors now to make those changes. |
I am sorry for the late changes to the paper, I hope this does not cause too many issues. But i think all the co-authors are now happy and we can proceed. |
@editorialbot generate pdf |
@markus1978 thanks for making those changes. I have some more minor points below:
|
@Kevin-Mattheus-Moerman thanks you very much for your suggestions. We now follow your suggestion for the last 3 points. For the first point, I would like to keep the acronym if possible. "ELN" is so prevalent in our community that for many readers "ELN" is more recognisable than "electronic lab notebook". |
@editorialbot generate pdf |
Thanks for making the changes. I think the use of |
@markus1978 Apologies for the delay in processing this. Thanks for implementing those final changes. I'll now proceed to accept this work for JOSS. |
@editorialbot accept |
|
Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository. If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file. You can copy the contents for your CITATION.cff file here: CITATION.cff
If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation. |
🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? Notify your editorial technical team... |
@zhubonan @Andrew-S-Rosen @sgbaird @berquist @Kevin-Mattheus-Moerman I am very happy that the paper was accepted and published. Many thanks to all editors and reviewers. |
@markus1978 congratulations on this publication in JOSS! Thanks for editing @zhubonan! And a special thank you to the reviewers: @arosen93, @berquist, @sgbaird |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: 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:
|
Congrats @markus1978, and thanks to you all helping this work through the process! @berquist @Kevin-Mattheus-Moerman @Andrew-S-Rosen @sgbaird 🤝😆 |
Thank you very much to all the editors and reviewers! 🚀 |
Submitting author: @markus1978 (Markus Scheidgen)
Repository: https://github.com/nomad-coe/nomad
Branch with paper.md (empty if default branch): paper
Version: v1.2.1
Editor: @zhubonan
Reviewers: @arosen93, @berquist, @sgbaird
Archive: 10.5281/zenodo.8366163
Status
Status badge code:
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
@arosen93 & @berquist & @sgbaird, 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:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @zhubonan 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 @berquist
📝 Checklist for @sgbaird
📝 Checklist for @arosen93
The text was updated successfully, but these errors were encountered: