-
-
Notifications
You must be signed in to change notification settings - Fork 38
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]: X-PSI: A Python package for neutron star X-ray Pulse Simulation and Inference #4977
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 |
|
Besides the linked "LICENSE.rst" license file link being broken in https://github.com/xpsi-group/xpsi#copyright-and-licensing , I want to point out that it's not really possible to release a project under MIT license if it depends on GPL libraries. One of your named dependencies is GSL. see https://www.gnu.org/software/gsl/#licensing Also MultiNest is not open source, so if the project depends on it, you need to add a GPL with exception to allow redistributing as a package. That is what PyMultiNest does as well, so you could adopt the licence from there. You can circumvent this requirement if your project has an interface which allows multiple inference engines (e.g., allow the user to switch in UltraNest instead of MultiNest), and thus is not reliant on running/building with MultiNest. |
Thanks a lot @JohannesBuchner, for pointing out the issue with the license! @drannawatts I'd propose to resolve this first, before we proceed with a more detailed review. Do you see any issue in re-licensing your project to fulfill the compatibility with the GSL dependency? |
Review checklist for @matteobachettiConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @JohannesBuchnerConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Re-licensing under the GPL potentially limits its future usage (as this exchange shows), so I would be wary of going that path. |
In any case, cython is compiled here. An alternative is to rewrite the package without GPL dependencies. |
Thanks @matteobachetti for joining so quickly!
This is my understanding too.
From what I can tell, this seems not a real option now. The GSL routines are used in many, many places for integration and interpolation. This seems like a major refactoring for the project which recently tagged v1.0. However I agree that the code readability and accessibility would actually benefit from relying on e.g. Scipy functionality. To me it seems the short term option is re-licensing and then including larger refactoring in a roadmap for v2.0. |
I agree that re-licensing is the easiest and safest option. Here are the two files you need: https://github.com/JohannesBuchner/PyMultiNest/blob/master/LICENSE (adjust the first line, and take note of the last paragraph) |
I also asked the JOSS editorial team for advice and there was the proposal to maybe choose a dual license here. Here is the quote:
This would allow complying with GSL, while maximizing the reuse of other parts of the software which might not depend on GSL. The downside is probably just that it's a rare thing to do and might need a more complex license description... |
Thank you for all of your input on this!! I think re-licensing is probably the only way to go for now - I'll discuss properly with the rest of the team tomorrow just in case I've missed anything and then get this fixed ASAP. Will update here once it's done! |
License files and links are now updated, thanks again! |
@drannawatts (and also @JohannesBuchner ) I tried to install it following the instructions at https://xpsi-group.github.io/xpsi/install.html
It seems that pymultinest does not find the compiled Multinest library. Maybe there needs to be some addition to |
Hi Matteo. The solution is indeed to export the following path (or something similar depending on where MultiNest was installed): |
@thjsal yes, it would be good to add this step to the instructions please |
@matteobachetti @JohannesBuchner we are creating GitHub issues tagged 'jossreview' for all of the things that you raise in review. We'll most likely try to address them all together unless you feel that they are so serious that they are holding you up in which case we'll get them fixed straight away! |
Happy new year everyone! This is just a quick reminder for @JohannesBuchner and @matteobachetti to continue their review. |
Hi @adonath , thanks for the reminder. I got a little lost, I was expecting some updates on if the issues got solved, in particular the ones about installation |
Hi @matteobachetti, what you were still waiting for from us on installation? Did the fix that @thjsal gave you on Dec 9 not solve the problem? We have a github issue raised to make sure that this step (which currently appears only on the HPC installation page) is also copied to the main install instructions, but as I mentioned in my comment on Dec 9 we were thinking to do this 'en masse' with any other issues raised during the review process. But as I mentioned above we're happy to fix things straight away if they are holding you up!! |
👋 @openjournals/aass-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#3964, then you can now move forward with accepting the submission by compiling again with the command |
Looks good to us! |
@drannawatts — I've submitted a PR with some minor edits, but I have one other request before the final processing: Can you update the metadata for the Zenodo archive so that the title and author list exactly match the paper? There should be an "edit" button at the top right of that page. |
Metadata updated (middle initial for my name, and full addresses instead of abbreviated ones), and title. Just checking the PR now! |
@editorialbot generate pdf |
@editorialbot recommend-accept |
|
|
👋 @openjournals/aass-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#3966, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot accept |
|
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦 |
🐘🐘🐘 👉 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... |
Many thanks to @JohannesBuchner and @matteobachetti for reviewing and to @adonath for editing! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you!! @drannawatts et al. — Your paper is now accepted and published in JOSS! ⚡🚀💥 |
🎉🎉🎉 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:
|
Congratulations @drannawatts and co-authors! Thanks @dfm for chief editing! |
Thank you to all of you @adonath @dfm @JohannesBuchner @matteobachetti , this has been a really great experience and both code and paper are much improved as a result of your efforts! |
Submitting author: @drannawatts (Anna Watts)
Repository: https://github.com/xpsi-group/xpsi
Branch with paper.md (empty if default branch):
Version: v1.2.2
Editor: @adonath
Reviewers: @JohannesBuchner, @matteobachetti
Archive: 10.5281/zenodo.7632629
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
@JohannesBuchner & @matteobachetti, 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 @adonath 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 @matteobachetti
📝 Checklist for @JohannesBuchner
The text was updated successfully, but these errors were encountered: