-
-
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]: Time-frequency component of the Green-X library: minimax grids for efficient RPA and GW calculations #5570
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 |
|
@aziziph My suggestion is wait for the reviewer feedback, then open an MR off of this issue, which addresses the points. The reviewers can then check diff and confirm we have sufficiently addressed points/concerns. |
Review checklist for @DarioALeonValidoConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Dear Maryam and other authors, I find this library potentially very useful. However, my main concern so far is regarding validation and performance, that are left to an unpublished paper (Azizi et al 2023). I suggest you to include here at lest a simple example illustrating the efficiency of the minimax grids. Maybe it could be done by integrating a toy function, but I also would like to see if you can get an estimate of how much it is reduced the prefactor of low-scaling MP2/RPA/GW calculations to justify the exclusive use of this particular quadrature. Another related question. In line 150 of the pdf you specify that the number of time/frequency points in the library ranges from 2 to 64, how are these values related to the final accuracy of correlation and quasi-particle energies? |
Hi @aziziph, re-pinging the message above. The review process in JOSS is different from other journals in that it is more of a conversation back and forth (rather than a review that is completed in one go, which is then responded to in one go). My advice would be to start responding to points as they are raised. Usually the review process will include several merged PRs, and the reviewers keep track using the checklist. As mentioned in the pre-review, I suggest renaming the license file to LICENSE.txt as that is standard for gh repos (and will be automatically recognised as a license by gh), and there are a couple of invalid DOIs reported in the thread above. |
Review checklist for @mailhexuConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Hello @mailhexu @aziziph @DarioALeonValido |
@aziziph Dear Mariam and other authors, Thanks for making this library available! I think it can be very useful. I found a few minor issues during the reviewing procedure: I have some minor suggestions below:
|
@mailhexu Not sure it will let me tag you as a reviewer, but here's the MR addressing issues 49 and 51: |
It seems I cannot review the MR. But I had a look and it seems the issues are well addressed. |
Dear Maryam, thanks for providing this example. These results seem very promising indeed. Since you are using the minimax grid as a reference, I wonder if the Gauss-Legendre grid is converging to a different value around 10^-3 eV. I guess you will comment on this in the benchmarking paper. I see that all the issues raised by the other referee have been corrected, so I am happy to recommend the paper for publication without further ado. All the best, |
Hi @DarioALeonValido - thanks for your expertise in reviewing the paper. Hi @aziziph @AlexBuccheri - I agree that there is not space for the efficiency comparison in the JOSS paper. As this is the key performance claim of the software, a link to this comparison in the documentation or in a paper published elsewhere is required. Ideally it would be both. I note that the paper you link to is currently unpublished - is there a pre-print available? I agree with @mailhexu that the documentation is quite inaccessible in its current form; requiring user installation to access (I think, it is not clear) function-level documentation. It is not easy for potential users to understand the software capabilities and use cases without reading the JOSS paper, which requires pdf download. I suggest you make this information (software capabilities, use cases, API docs) available as webpages. This could be hosted on github pages, for example. At a minimum, this information (minus the API docs) need to be available on the README.md. Happy to discuss this more if anything is unclear. Exploring previous repos published in JOSS can be a good way to find strong documentation examples. I can see this is being discussed on the issue here. |
A follow on note to say that by having a documentation webpage you will be able to cut the details in your JOSS paper. The JOSS paper is an advert for the repo, it does not need to go into details of the implementation (it is not the place for the e.g. mathematical framework section). This is better in the online docs. |
Dear Lucy, thank you very much for providing this possible solution. I coincide with you that an illustrative example in support of the claims of the library should be available at a preprint of the benchmarking reference or somewhere else beside this thread. |
Dear @aziziph @AlexBuccheri @Panadestein - A heads up that I am going on annual leave until the 8th of August. The primary outstanding issue relates to documentation, which I can see is under discussion (nomad-coe/greenX#59). If you have any questions relating to this I will briefly have access to internet this Monday 24th, otherwise I will be off-grid! There are also some more minor issues raised by @mailhexu (nomad-coe/greenX#48 nomad-coe/greenX#49 nomad-coe/greenX#51 nomad-coe/greenX#52). Hopefully this gives a good timeline for completion; I will check back here ASAP after returning from AL as I think we are getting close to the end! Lucy |
|
👋 @openjournals/pe-eics, this paper is ready to be accepted and published. Check final proof 👉📄 Download article If the paper PDF and the deposit XML files look good in openjournals/joss-papers#4641, then you can now move forward with accepting the submission by compiling again with the command |
Looks like this is fixed now. I'll let @kyleniemeyer take over from here. |
Thanks @Panadestein and the rest of the team, got there in the end! |
@lucydot is action required from our side? Do we have to reply in openjournals/joss-papers#4641 |
@dgolze just a question: can you explain why GW is italicized in the title and text, while other acronyms like RPA are not? |
It's in Italic because of convention. |
OK, thanks @aziziph! |
@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... |
@kyleniemeyer thanks for accepting the manuscript. The title seems to have been rendered incorrectly though, I can see in my mobile device |
@openjournals/dev looks like some LaTeX markup got caught in the title at https://doi.org/10.21105/joss.05570, does that need to be fixed manually? |
@kyleniemeyer is there a chance that the title on the website gets fixed --> \textit{GW} |
@kyleniemeyer the article already got indexed by Google Scholar and ResearchGate with this latex code in the title. That does not look good for anybody. Would you mind taking a look at this issue? Thanks |
@openjournals/dev @arfon can the title for this paper be fixed manually? I don't think I can do this myself. |
@aziziph – please merge this PR. @kyleniemeyer then you can run reaccept here: https://joss.readthedocs.io/en/latest/editorial_bot.html?highlight=reaccept#updating-an-already-accepted-paper |
@editorialbot reaccept |
|
🌈 Paper updated! New PDF and metadata files 👉 openjournals/joss-papers#4662 |
Thanks, @arfon. I thought fixing this would involve some manual magic on the website. @Panadestein @dgolze the website appears correct for me now, and indexers should update after some time as well. |
🎉🎉🎉 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:
|
Submitting author: @aziziph (Maryam Azizi)
Repository: https://github.com/nomad-coe/greenX
Branch with paper.md (empty if default branch): main
Version: v1.0.0
Editor: @lucydot
Reviewers: @mailhexu, @DarioALeonValido
Archive: 10.5281/zenodo.8321618
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
@mailhexu & @DarioALeonValido, 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 @lucydot 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 @DarioALeonValido
📝 Checklist for @mailhexu
The text was updated successfully, but these errors were encountered: