-
-
Notifications
You must be signed in to change notification settings - Fork 36
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]: GCIdentifier.jl: A Julia package for identifying molecular fragments from SMILES #6453
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:
|
|
Software report:
Commit count by author:
|
Paper file info: 📄 Wordcount for ✅ The paper includes a |
License info: ✅ License found: |
Review checklist for @moynerConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Hi @Arrondissement5etDemi, @mjohnson541, @moyner Thanks again for agreeing to review this submission 👍. @Arrondissement5etDemi, @mjohnson541 please generate your checklists and get started! It would be great to have the review done in two weeks time as this package is relative small. Please let me know if you have any problem or require a bit time. Cheers. |
## Review checklist for @Arrondissement5etDemi
### Conflict of interest
- [ ] I confirm that I have read the [JOSS conflict of interest (COI) policy](https://github.com/openjournals/joss/blob/master/COI.md) 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
- [ ] I confirm that I read and will adhere to the [JOSS code of conduct](https://joss.theoj.org/about#code_of_conduct).
### General checks
- [ ] **Repository:** Is the source code for this software available at the [https://github.com/ClapeyronThermo/GCIdentifier.jl](https://github.com/ClapeyronThermo/GCIdentifier.jl)?
- [ ] **License:** Does the repository contain a plain-text LICENSE or COPYING file with the contents of an [OSI approved](https://opensource.org/licenses/alphabetical) software license?
- [ ] **Contribution and authorship:** Has the submitting author (@pw0908) 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](https://joss.readthedocs.io/en/latest/submitting.html#substantial-scholarly-effort)
- [ ] **Data sharing:** If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
- [ ] **Reproducibility:** If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
- [ ] **Human and animal research:** If the paper contains original data research on humans subjects or animals, does it comply with [JOSS's human participants research policy and/or animal research policy](https://joss.readthedocs.io/en/latest/policies.html?highlight=animal#joss-policies)? If the paper contains no such data, please check this item.
### 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, who the target audience is, and its relation to other work?
- [ ] **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](https://pandoc.org/MANUAL.html#extension-citations)?
|
Review checklist for @Arrondissement5etDemiConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@editorialbot generate pdf |
No clue what happened there but it looks like the pdf compiled just fine, the bot just didn't manage to link it to this issue: https://raw.githubusercontent.com/openjournals/joss-papers/joss.06453/joss.06453/10.21105.joss.06453.pdf |
Hi Pierre,
This works, thanks a lot!
Best regards,
Haina
…________________________________
From: Pierre Walker ***@***.***>
Sent: Tuesday, March 12, 2024 18:39
To: openjournals/joss-reviews ***@***.***>
Cc: Haina Wang ***@***.***>; Mention ***@***.***>
Subject: Re: [openjournals/joss-reviews] [REVIEW]: GCIdentifier.jl: A Julia package for identifying molecular fragments from SMILES (Issue #6453)
No clue what happened there but it looks like the pdf compiled just fine, the bot just didn't manage to link it to this issue: https://raw.githubusercontent.com/openjournals/joss-papers/joss.06453/joss.06453/10.21105.joss.06453.pdf
—
Reply to this email directly, view it on GitHub<#6453 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AKIGQVQWDPBNCIEY6KBTXDLYX6U5VAVCNFSM6AAAAABEMSGRJGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOJTGAZTQMJRHE>.
You are receiving this because you were mentioned.
|
No worries Haina! |
Review checklist for @mjohnson541Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
I was unable to install on a clean Julia 1.6.7 install from conda-forge. It looks like an issue with Cairo:
|
As far as the documentation, on Home it claims "GCIdentifier.jl: An extensible Julia package for the modelling of fluids using thermodynamic equations of state." Which this software does not seem to do. I suspect this was accidentally copied from Clapeyron.jl. This should have a description of the software and what it can be used to do. |
Hi Matt! For the home page: that is a very silly mistake! We did copy our initital documentation template from Clapeyron, but it seems we forgot to change the opening lines. We have now fixed this. As for the installation error, are you certain of the Julia version? I've tried installing Julia 1.6.7 from conda-forge, but there is only 1.6.6, the next version up is 1.7.0. It's also strange that the tests fail on 1.6 as our automated tests include 1.6 and they've been passing. These only currently run on ubuntu so perhaps this is an issue with the OS? |
Sorry, that was a mistake, I installed Julia v1.6.5 I am on osx though, which might be relevant. |
I can try on ubuntu later. |
We have now added macos and windows to our tests to see if this might be the issue. (MacOS just passed its tests) I also made a mistake: 1.6.7 is the long-term support version of 1.6. But this was the version being tested on ubuntu either way. Update: Windows also passed. |
@mjohnson541 Just tried installing GCIdentifier on a clean version of Julia 1.6.5 in Ubuntu without issue. It might just be a MacOS issue (are you using an M-series mac?). |
@moyner @mjohnson541 @Arrondissement5etDemi Is there anything we can help with? @longemen3000 and I would be happy to assist with any issues you might be encountering during your review! |
@editorialbot set v0.3.1 as version |
Done! version is now v0.3.1 |
@editorialbot set 10.5281/zenodo.10914015 as archive |
Done! archive is now 10.5281/zenodo.10914015 |
@editorialbot recommend-accept |
|
|
👋 @openjournals/bcm-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#5206, then you can now move forward with accepting the submission by compiling again with the command |
as AEiC for JOSS I will now help to process this submission for acceptance in JOSS. I have checked this review, your repository, the archive link, and the paper. Most seems in order and I only have below point that requires your attention:
|
Yes! Thank you for catching this. I have now fixed the typo. |
@editorialbot generate pdf |
One more thing @pw0908 can you check that you always use spaces before the brackets of a reference? See below I highlight some correct and incorrect locations: |
I'll deal with that now! |
@Kevin-Mattheus-Moerman Should be fixed now |
@editorialbot generate pdf |
@Kevin-Mattheus-Moerman I'll be up for another hour or so if there's any more changes you'd like me to make! |
@editorialbot accept |
|
Nope, it looks like you'll wake up to an accepted paper :) |
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... |
@pw0908 congratulations on this publication I'd like to thank @zhubonan for editing and especially would especially like to thank the reviewers: @Arrondissement5etDemi, @mjohnson541, @moyner |
🎉🎉🎉 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: @pw0908 (Pierre Walker)
Repository: https://github.com/ClapeyronThermo/GCIdentifier.jl
Branch with paper.md (empty if default branch): main
Version: v0.3.1
Editor: @zhubonan
Reviewers: @Arrondissement5etDemi, @mjohnson541, @moyner
Archive: 10.5281/zenodo.10914015
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
@Arrondissement5etDemi & @mjohnson541 & @moyner, 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 @Arrondissement5etDemi
📝 Checklist for @moyner
📝 Checklist for @Arrondissement5etDemi
📝 Checklist for @moyner
📝 Checklist for @mjohnson541
The text was updated successfully, but these errors were encountered: