-
-
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]: Heta compiler: a software tool for the development of large-scale QSP models and compilation into simulation formats #3708
Comments
Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @martinmodrak, @elimillera it looks like you're currently assigned to review this paper 🎉. Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post. ⭐ Important ⭐ If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿 To fix this do the following two things:
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:
|
PDF failed to compile for issue #3708 with the following error:
|
|
@whedon generate pdf from branch paper |
|
@elimillera - Thanks again for agreeing to review! It looks like you might not have accepted the invitation from whedon, the JOSS bot. If this is the case, please feel free to accept the invitation so that you can check items in the above checklist. I think that the invitation expires in a few days. Thanks again! |
👋 @elimillera, please update us on how your review is going (this is an automated reminder). |
👋 @martinmodrak, please update us on how your review is going (this is an automated reminder). |
Review is going well. I've reviewed the easy things to check and so far so good. Its been a couple years from when I was last working with models like these so I'm taking some time and checking some other sources as I go through it. I expect to be close to finished in the next 2-3 weeks. |
Thanks, @elimillera ! I appreciate your thoroughness. As you work through the review, please let me know if I can assist with anything. Thanks again! |
@martinmodrak - How is the review going? Do you have any questions about completing the checklist of items? |
@elimillera - how is the review going? Can I assist you with anything? |
@fboehm I've played around with it. I'm hoping to be finished by this Sunday. |
Thanks, @elimillera! Did you have a chance to continue with your review? |
Hello @fboehm I am finished with my review. I have a PR open hetalang/heta-compiler#9 with some word changes but otherwise everything looked good. |
@elimillera, thank you for your efforts. I've accepted all your remarks. I guess it improves the quality of the paper. Should I do anything else? |
Thanks, @metelkin ! If you've addressed all of the issues from @elimillera , then there's nothing for you to do right now. we'll just need to wait for @martinmodrak to complete the review. |
Sorry to have kept everybody waiting. I finally managed to do a first pass through the software and paper. This is a neat piece of software that looks well documented and well written. So far I haven't encountered any major obstacle. My suggestions so far are minor, and may not even need immediate resolution for acceptance in JOSS.
I still plan to spend some more time trying the software out, but wanted to share my results so far to let you react. |
@martinmodrak,
|
I agree the focus is elsewhere. I would just find it helpful to learn what I gain by writing the model in Heta and then compiling to SBML as opposed to directly writing SBML. I am choosing SBML as it appears to have quite a broad support, so presumably many workflows with Heta would involve compiling to SBML to get access to the vast ecosystem of tools that support it. One or two sentences would probably be needed to satisfy the "State of the field" requirement, however no need for an extended comparison just for me.
Unfortunately, this doesn't appear to be the case: hetalang/heta-compiler#11 There is also potentially problematic design in the way the definition of export targets is part of the model specification. One could IMHO argue that there should be a separation between model definition and export targets. E.g. if I want to share my model with the community, I probably don't want to prescribe how the community will export it. Conflicting needs of different team members could lead to unnecessary version control conflicts in the export definitionsm etc. The need for Some (not mutually exclusive) options to consider:
Generally, handling exports well seems like an important (but hard) design decision. As with the other stuff, I don't insist on this being resolved for acceptance in JOSS, just wanted to share my concerns. In summary, I think the only really blocking problem is fulfilling the "State of the field" requirement by at least briefly contrasting what one can do with Heta that one could not accomplish with SBML or other common tool. There are a bunch of suggestions and two bugs I noticed, but I am OK with acceptance even if those are not addressed. |
I have added one sentence to mention the most known standard representation of bio-models. See the latest version in the "paper" branch. See below.
For a broader discussion here, I need to mention that SBML (as an example) and Heta are not competitors. Heta, in general, is a human-readable language that has been created to optimize the process of model development by users. SBML is an industrial xml-based standard for model exchange. I posted here a quote from SBML official site http://sbml.org
I know nobody who manually edits SBML in his everyday modeling workflow. Anyway to develop the SBML model you have to use another layer: graphical programming (like in SimBiology), table creation (like in DBSolve), or use a DSL like in mrgsolve which is usually applicable for a single tool only. |
@whedon generate pdf from branch paper |
Thanks, @metelkin ! |
@metelkin - I failed to tell you that the title of the archive needs to be the same as the title of the paper. Can you please fix this? Thanks again! Right now, it looks like the title of the archive is: hetalang/heta-compiler: Version 0.6.7 - ready for JOSS |
@fboehm - No problem. Done! |
@metelkin - Excellent! |
@whedon set v0.6.7 as version |
OK. v0.6.7 is the version. |
set 10.5281/zenodo.5666487 as archive |
@whedon set 10.5281/zenodo.5666487 as archive |
OK. 10.5281/zenodo.5666487 is the archive. |
@whedon recommend-accept |
|
👋 @openjournals/joss-eics, this paper is ready to be accepted and published. Check final proof 👉 openjournals/joss-papers#2741 If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#2741, then you can now move forward with accepting the submission by compiling again with the flag
|
|
Actually - @metelkin - can you add the doi suggested above to your bib file? I didn't see until now the output of the check references command. Thanks again! |
@fboehm - I've added the required doi to the bib file. |
Perfect! Thanks @metelkin ! |
@whedon generate pdf |
@whedon accept deposit=true |
|
🐦🐦🐦 👉 Tweet 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... |
Congratulations @metelkin on your article's publication in JOSS! Many thanks to @martinmodrak and @elimillera for reviewing this, and @fboehm for editing. |
🎉🎉🎉 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! 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: @metelkin (Evgeny Metelkin)
Repository: https://github.com/hetalang/heta-compiler
Version: v0.6.7
Editor: @fboehm
Reviewer: @martinmodrak, @elimillera
Archive: 10.5281/zenodo.5666487
Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.
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
@martinmodrak & @elimillera, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @fboehm 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 ✨
Review checklist for @martinmodrak
✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
Review checklist for @elimillera
✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
The text was updated successfully, but these errors were encountered: