-
-
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]: TelescopeML -- I. An End-to-End Python Package for Interpreting Telescope Datasets through Training Machine Learning Models, Generating Statistical Reports, and Visualizing Results #6346
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 |
|
@oparisot thanks for agreeing to review! To generate your reviewer checklist, in this thread please comment:
Then when you get a chance, please begin making your way through the checklist. Let me know if you have any questions! |
Review checklist for @oparisotConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@plaplant, thanks again for assigning a reviewer, and @oparisot, thank you for dedicating your time to review this package! @oparisot I'll make sure to check and address all your comments, but please don't hesitate to reach out if you have any questions or share any instructions, as this is my first JOSS submission and experience with this process. |
Hello @EhsanGharibNezhad, I will go deeply into the review, but before, you should add a short summary in the paper, as required in JOSS guidelines: "A summary describing the high-level functionality and purpose of the software for a diverse, non-specialist audience." Moreover, you should clarifiy the 'Functionality and Key Features'. The current paper proposes a high-level list of features, but it is too vague. You should describe the inputs and outputs (files formats? time series?), you should present the goal of AI models (what do you mean by 'predicting atmospheric parameters'?),you should describe the type of CNN, etc. Finally, you should position and compare your software to existing tools (ex https://github.com/MartianColonist/POSEIDON, if it not appropriate then please list tools that are 'comparable' to your software. I will test the software in few days. Thank you, Olivier |
Hi @oparisot, Thanks for the feedback. I'll make sure to address your comments within the next few days and find the softwares that I could compare my package with. |
@editorialbot add @mwalmsley as reviewer |
@mwalmsley added to the reviewers list! |
Hi Oliver @oparisot: To address your comments, I added the following sections:
I also modified the Functionality and Key Features section to clearly list the tasks. Besides, I updated the DOIs suggested earlier. Please let me know if it still looks vague. Thank you! |
Hi Paul @plaplant, Just making sure I'm not missing anything, all the comments will be listed here in the GitHub thread, right? |
@EhsanGharibNezhad for comments on the submission, we leave that up to the reviewers' preference. Some will make comments in this review thread, and others will make issues on the software repository and reference them as part of this thread, especially if the comments are more involved or there are several issues that need to be addressed. Either way, at least a reference should appear in this thread. @oparisot thanks very much for your initial review! When you get a chance, please provide any additional feedback you have, either as a comment on this thread or by making an issue on the software repository. Thanks! @mwalmsley when you get a chance, please make the following comment in this thread:
Then please start going through the review elements contained in the checklist. Let me know if you have any questions! |
Thank you for the update of the paper. Ideas to improve the repository: can you add a short 'contribution guide' (ex: https://contributing.md/example/)? Olivier |
The software is easy to use by following the instructions, and the use-cases are well explained. I'm in favour of accepting the paper, if guidelines (even slight ones) for contribution / support are added in the git repository. Olivier |
Hi Oliver @oparisot, This is a great comment. Thanks for sharing this link. I added two docs to the main branch to address that:
|
@EhsanGharibNezhad I've tested the software and it works well - the use cases are well described in the documentation and run efficiently. Great job! |
@oparisot thanks for your review! If you have completed all components of the reviewer checklist, please tick the boxes so we can consider the review "complete". @mwalmsley when you get a chance, please comment |
Great! Thank you Oliver for taking the time and testing the package. |
Review checklist for @mwalmsleyConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@editorialbot check references |
|
@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#5587, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot accept |
I'm sorry @EhsanGharibNezhad, I'm afraid I can't do that. That's something only eics are allowed to do. |
@plaplant I'm not sure if I need to compile that command? |
@EhsanGharibNezhad apologies for the confusion. I don't personally have the authority to officially accept a publication, as that can only be done by one of the Editors-in-Chief (eics). I have recommended its acceptance, so now it goes to them to officially accept. This process usually happens within a few days, but I will follow up early next week if it hasn't happened by then. |
No problem! Thank you! :) |
@EhsanGharibNezhad — I've opened a small PR with some typographic edits. Once you merge that I can proceed with acceptance. |
@dfm Done! Thanks! |
@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#5649, then you can now move forward with accepting the submission by compiling again with the command |
@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... |
Many thanks to @oparisot and @mwalmsley for reviewing and to @plaplant for editing! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you!! @EhsanGharibNezhad — Your paper is now accepted and published in JOSS! ⚡🚀💥 Note: I'm currently seeing that the PDF isn't appearing on the DOI page. This sometimes happens for a few hours because of some caching issues on the back end. If this doesn't resolve itself by tomorrow, let me know and I'll look into it! |
🎉🎉🎉 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:
|
Thank you all! It was a wonderful experience going through all steps! :) |
Submitting author: @EhsanGharibNezhad (Ehsan Gharib-Nezhad)
Repository: https://github.com/EhsanGharibNezhad/TelescopeML
Branch with paper.md (empty if default branch): joss
Version: 0.0.5
Editor: @plaplant
Reviewers: @oparisot, @mwalmsley
Archive: 10.5281/zenodo.11553655
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
@oparisot, 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 @plaplant 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 @oparisot
📝 Checklist for @mwalmsley
The text was updated successfully, but these errors were encountered: