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]: gtk-fortran: a GTK+ binding to build Graphical User Interfaces in Fortran #1109

Closed
whedon opened this Issue Nov 29, 2018 · 56 comments

Comments

Projects
None yet
7 participants
@whedon
Copy link
Collaborator

whedon commented Nov 29, 2018

Submitting author: @vmagnin (Vincent MAGNIN)
Repository: https://github.com/jerryd/gtk-fortran
Version: v17.10
Editor: @Kevin-Mattheus-Moerman
Reviewers: @johnsamuelwrites, @sundmanbo
Archive: 10.5281/zenodo.2544192

Status

status

Status badge code:

HTML: <a href="http://joss.theoj.org/papers/33eda34ec9fd549844fb43ca28dd879a"><img src="http://joss.theoj.org/papers/33eda34ec9fd549844fb43ca28dd879a/status.svg"></a>
Markdown: [![status](http://joss.theoj.org/papers/33eda34ec9fd549844fb43ca28dd879a/status.svg)](http://joss.theoj.org/papers/33eda34ec9fd549844fb43ca28dd879a)

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) 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

@johnsamuelwrites & @sundmanbo, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

  1. Make sure you're logged in to your GitHub account
  2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @Kevin-Mattheus-Moerman know.

Please try and complete your review in the next two weeks

Review checklist for @johnsamuelwrites

Conflict of interest

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Version: Does the release version given match the GitHub release (v17.10)?
  • Authorship: Has the submitting author (@vmagnin) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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 function 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

  • Authors: Does the paper.md file include a list of authors with their affiliations?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

Review checklist for @sundmanbo

Conflict of interest

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Version: Does the release version given match the GitHub release (v17.10)?
  • Authorship: Has the submitting author (@vmagnin) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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 function 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

  • Authors: Does the paper.md file include a list of authors with their affiliations?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Nov 29, 2018

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @johnsamuelwrites, it looks like you're currently assigned as the reviewer for this paper 🎉.

⭐️ 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:

  1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

watching

  1. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

notifications

For a list of things I can do to help you, just type:

@whedon commands
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Nov 29, 2018

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Nov 29, 2018

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Nov 29, 2018

@johnsamuelwrites, @devonrex, @sundmanbo this is where the review takes place. There are tick boxes at the top if this issue to guide you through the process. Please let me know if you have any questions. Thanks! 🤖 🚀

@sundmanbo

This comment has been minimized.

Copy link
Collaborator

sundmanbo commented Dec 1, 2018

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Dec 1, 2018

@sundmando yes that is annoying. The top of this issue contains instructions to avoid this. I.e. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews. Let me know if you need more help.

@sundmanbo

This comment has been minimized.

Copy link
Collaborator

sundmanbo commented Dec 1, 2018

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Dec 1, 2018

Yes I need more help. Where do I find a "No watching" button?

@sundmanbo - if you might want to change your settings in your GitHub profile here to stop emails being sent:

@johnsamuelwrites

This comment has been minimized.

Copy link
Collaborator

johnsamuelwrites commented Dec 10, 2018

@Kevin-Mattheus-Moerman @vmagnin v17.10 is the specified version for the journal. gtk-fortran follows a different versioning scheme, making use of the gtk version as well. For example: https://github.com/jerryd/gtk-fortran/releases shows v17.10.gtk3.22.25 and v17.10.gtk2.24.31. Is it possible to specify these two versions?

@vmagnin

This comment has been minimized.

Copy link

vmagnin commented Dec 11, 2018

@Kevin-Mattheus-Moerman @vmagnin v17.10 is the specified version for the journal. gtk-fortran follows a different versioning scheme, making use of the gtk version as well. For example: https://github.com/jerryd/gtk-fortran/releases shows v17.10.gtk3.22.25 and v17.10.gtk2.24.31. Is it possible to specify these two versions?

Each version of gtk-fortran is numbered using the Ubuntu version used to build it, for example 17.10: but each release comprises a GTK+ 2 version and a GTK+3 version. And 3.22.25 and 2.24.31 are the precise GTK+ versions used to build gtk-fortran.

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 4, 2019

Happy New Year to all!

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 4, 2019

@johnsamuelwrites, @devonrex, @sundmanbo can you provide an update on the review process? Let me know if I can help with anything. Thanks.

@sundmanbo

This comment has been minimized.

Copy link
Collaborator

sundmanbo commented Jan 4, 2019

@johnsamuelwrites

This comment has been minimized.

Copy link
Collaborator

johnsamuelwrites commented Jan 6, 2019

gtk-fortran is GTK+/Fortran binding helping the Fortran programmers to build cross-platform GUI applications (though the authors mainly focus on Linux based machines). The need for the software is clear considering the lack of such tools with
an open licence. The tool has an associated Wiki on the GitHub page which explains the functionality and the installation procedures. In addition to this, the Wiki page also gives links to other external documents on how to build applications using gtk-fortran. A number of examples are given in the examples/ folder for the new comers. All the examples in the examples/ folder can be run as tests. These tests, however require manual intervention (e.g., the need to close the GUI windows.) But given the scope of this tool, I think it's not a major issue.

GitHub issues are used for reporting any problem. There is a 'How can I help?' section on the Wiki page for developers who visit to contribute.

I accept this software. The authors also have responded, clarified and made corrections to the issues/comments previously opened by me during the review/preview process.

There are some minor corrections/suggestions that need to be made on the Wiki page:

  1. The link 'How to use GTK-Fortran with Code::Blocks IDE' is broken in the section 'Some external docs about gtk-fortran'
  2. A quick start tutorial could be useful (something similar to the one given in the Fortran Tools - Chapter 16: GTK) on the main Wiki page.
  3. Explore the possibility of fully automating the test run.
@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 7, 2019

@vmagnin can you work on / formulate a reply to @johnsamuelwrites 's comments? Thanks

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 7, 2019

@devonrex are you able to review this software soon? Thanks

@vmagnin

This comment has been minimized.

Copy link

vmagnin commented Jan 7, 2019

@Kevin-Mattheus-Moerman

Thank you @johnsamuelwrites for that review. Concerning your three final comments:

  1. I clicked on the link 'How to use GTK-Fortran with Code::Blocks IDE' on two different PCs today and it works fine. Perhaps there was a server problem the day you try it ?

  2. A quick start tutorial is a good idea and I can work on it during the next months.

  3. Fully automating the test run could be a long term project. I guess there is applications to test softwares with GUI, but I have no experience of that kind of software. If you have some idea on how it could be done, I am interested.

Finally, I can say that such a review process is very interesting because users generally only post bug reports or questions on how to do something with the soft, but there is very rarely comments or critics or even requests concerning the documentation of the soft.

@devonrex

This comment has been minimized.

Copy link
Collaborator

devonrex commented Jan 7, 2019

@johnsamuelwrites

This comment has been minimized.

Copy link
Collaborator

johnsamuelwrites commented Jan 8, 2019

@Kevin-Mattheus-Moerman @vmagnin Thanks for the response. I verified the link (review comment 1) and it's working now. Regarding review comment 3 on full automation, I am aware that it may be little difficult and may not be the immediate focus of gtk-fortran. As I mentioned in the review, the manual tests are fine, especially considering that this is a GUI building tool and some users may wish to run through all the tests manually.

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 8, 2019

@devonrex thanks for letting us know. I'll remove you as reviewer. For future reference the review entails downloading (e.g. the zip file for the repository if you like without using GIT) and testing the software. Then boxes are ticked at the top of this review issue. Editors are also here to help with the process. Thanks for your time.

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 8, 2019

@whedon remove @devonrex as reviewer

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 8, 2019

OK, @devonrex is no longer a reviewer

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 8, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 8, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 19, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 19, 2019

@vmagnin

This comment has been minimized.

Copy link

vmagnin commented Jan 19, 2019

Dear @Kevin-Mattheus-Moerman

I finally succeeded obtaining a DOI:

  • I have asked my coauthor jerryd to transfer to me the ownership of the repository. So the new URL of gtk-fortran is https://github.com/vmagnin/gtk-fortran (instead of https://github.com/jerryd/gtk-fortran, which now redirects toward the new URL).
  • I have updated that URL in the paper and have regenerated the PDF.
  • I have created a new release: v17.10.gtk3.22.25_2
  • And have obtained its DOI: 10.5281/zenodo.2544192
@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 31, 2019

@whedon check references

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 31, 2019

Attempting to check references...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 31, 2019


OK DOIs

- http://doi.org/10.1016/S0167-2991(08)80304-7 is OK
- http://doi.org/http://dx.doi.org/10.1016/j.apradiso.2015.12.003 is OK

MISSING DOIs

- None

INVALID DOIs

- None
@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Feb 10, 2019

@arfon @danielskatz @kyleniemeyer @labarba I recommend we accept this work in JOSS. The new version tag and DOI are:

  • I have created a new release: v17.10.gtk3.22.25_2
  • And have obtained its DOI: 10.5281/zenodo.2544192
@arfon

This comment has been minimized.

Copy link
Member

arfon commented Feb 12, 2019

@whedon set 10.5281/zenodo.2544192 as archive

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019

OK. 10.5281/zenodo.2544192 is the archive.

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Feb 12, 2019

@whedon accept

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019

Attempting dry run of processing paper acceptance...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019

PDF failed to compile for issue #1109 with the following error:

Can't find any papers to compile :-(

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Feb 12, 2019

@vmagnin have you removed the paper.md file from your repository? @whedon doesn't seem to be able to find it any longer.

@vmagnin

This comment has been minimized.

Copy link

vmagnin commented Feb 12, 2019

@arfon The paper.md, paper.bib and paper.png files are still in the master branch of the gtk-fortran repository. But some days ago I have changed the default branch of the repository from master (gtk2) to gtk3. Perhaps @whedon is searching in the default branch.
=> So, I have just copied and pushed the three paper.* files in the gtk3 branch. I hope it will solve the problem.

Another reason could be the ownership transfer one month ago from https://github.com/jerryd/gtk-fortran to https://github.com/vmagnin/gtk-fortran, but theoretically everything is automatically redirected from the old URL to the new.

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Feb 12, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Feb 12, 2019

@arfon The paper.md, paper.bib and paper.png files are still in the master branch of the gtk-fortran repository. But some days ago I have changed the default branch of the repository from master (gtk2) to gtk3. Perhaps @whedon is searching in the default branch.

Ah yes. @whedon only picks up files in the default branch.

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Feb 12, 2019

@whedon accept

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019

Attempting dry run of processing paper acceptance...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019


OK DOIs

- http://doi.org/10.1016/S0167-2991(08)80304-7 is OK
- http://doi.org/http://dx.doi.org/10.1016/j.apradiso.2015.12.003 is OK

MISSING DOIs

- None

INVALID DOIs

- None
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019

Check final proof 👉 openjournals/joss-papers#486

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#486, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true
@arfon

This comment has been minimized.

Copy link
Member

arfon commented Feb 12, 2019

@whedon accept deposit=true

@whedon whedon added the accepted label Feb 12, 2019

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019

Doing it live! Attempting automated processing of paper acceptance...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 openjournals/joss-papers#487
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01109
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? notify your editorial technical team...

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Feb 12, 2019

@johnsamuelwrites, @sundmanbo - many thanks for your reviews and to @Kevin-Mattheus-Moerman for editing this submission

@vmagnin - your paper is now accepted into JOSS ⚡️🚀💥

@arfon arfon closed this Feb 12, 2019

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](http://joss.theoj.org/papers/10.21105/joss.01109/status.svg)](https://doi.org/10.21105/joss.01109)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.01109">
  <img src="http://joss.theoj.org/papers/10.21105/joss.01109/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: http://joss.theoj.org/papers/10.21105/joss.01109/status.svg
   :target: https://doi.org/10.21105/joss.01109

This is how it will look in your documentation:

DOI

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:

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 12, 2019


OK DOIs

- http://doi.org/10.1016/S0167-2991(08)80304-7 is OK
- http://doi.org/http://dx.doi.org/10.1016/j.apradiso.2015.12.003 is OK

MISSING DOIs

- None

INVALID DOIs

- None
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment