search

openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
714 stars 38 forks source link

[REVIEW]: G'MIC: An Open-Source Self-Extending Framework for Image Processing #6618

Open editorialbot opened 5 months ago

editorialbot commented 5 months ago

Submitting author: !--author-handle-->@dtschump<!--end-author-handle-- (David Tschumperlé) Repository: https://github.com/GreycLab/gmic Branch with paper.md (empty if default branch): joss Version: 3.3.2 Editor: !--editor-->@gkthiruvathukal<!--end-editor-- Reviewers: @jamesrhester, @Smattr, @drj11 Archive: Pending

Status

status

Status badge code:

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

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

@jamesrhester & @Smattr & @drj11, 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:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @gkthiruvathukal 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 @jamesrhester

📝 Checklist for @drj11

📝 Checklist for @Smattr

editorialbot commented 5 months ago

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:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf
editorialbot commented 5 months ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.13 s (431.0 files/s, 349651.7 lines/s)
--------------------------------------------------------------------------------
Language                      files          blank        comment           code
--------------------------------------------------------------------------------
C++                               3            920            755          13939
SVG                               5             12              4          11995
JavaScript                       13           1127            207           9089
CSS                               3            160             68           1615
HTML                              6            116             70           1295
Markdown                          3            250              0            676
make                              3            112            331            589
CMake                             7             87             70            390
Bourne Again Shell                5             66            101            387
C/C++ Header                      1             99             94            382
TeX                               1             22              0            185
XML                               1              0              0             36
Scheme                            1             10             45             31
YAML                              2              1              4             19
Bourne Shell                      2              5             56              6
--------------------------------------------------------------------------------
SUM:                             56           2987           1805          40634
--------------------------------------------------------------------------------

Commit count by author:

  1089  David Tschumperle
     1  Garry R. Osgood
editorialbot commented 5 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1109/icip46576.2022.9897386 is OK
- 10.1109/icip46576.2022.9897334 is OK
- 10.1137/19m1306798 is OK
- 10.1109/tip.2015.2411437 is OK
- 10.1109/99.660313 is OK
- 10.1038/s41586-023-06551-1 is OK

MISSING DOIs

- No DOI given, and none found for title: ImageMagick
- No DOI given, and none found for title: GraphicsMagick
- No DOI given, and none found for title: CImg: C++ Template Image Processing Toolkit
- No DOI given, and none found for title: G’MIC: GREYC’s Magic for Image Computing
- No DOI given, and none found for title: A fast and efficient semi-guided algorithm for fla...
- No DOI given, and none found for title: A non-local algorithm for image denoising
- No DOI given, and none found for title: Mémoire sur l’itération des fonctions rationnelles
- No DOI given, and none found for title: The Buddhabrot Technique
- No DOI given, and none found for title: Lineart Bucket Fill
- No DOI given, and none found for title: Fractalius.
- No DOI given, and none found for title: David Revoy, Comic book artist and Art Director
- No DOI given, and none found for title: Pepper & Carrot, A free(libre) and open-source web...
- No DOI given, and none found for title: The MathMap Image Processing Application
- No DOI given, and none found for title: Pixelitor
- No DOI given, and none found for title: Filter Forge
- No DOI given, and none found for title: A cross-platform software for creating graphical u...
- No DOI given, and none found for title: A neural algorithm of artistic style

INVALID DOIs

- None
editorialbot commented 5 months ago

Paper file info:

📄 Wordcount for paper.md is 1576

✅ The paper includes a Statement of need section

editorialbot commented 5 months ago

License info:

🟡 License found: Other (Check here for OSI approval)

editorialbot commented 5 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

jamesrhester commented 5 months ago

Review checklist for @jamesrhester

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

drj11 commented 5 months ago

Review checklist for @drj11

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

gkthiruvathukal commented 5 months ago

@jamesrhester, @Smattr, @drj11 Have you been able to get started with this JOSS review?

danielskatz commented 4 months ago

👋 @gkthiruvathukal, @jamesrhester, @Smattr, @drj11 - I want to check on the progress of this review. Is there anything blocking its progress?

jamesrhester commented 4 months ago

Just haven't got to it yet, nothing blocking.

On Mon, 27 May 2024 at 17:39, Daniel S. Katz @.***> wrote:

👋 @gkthiruvathukal https://github.com/gkthiruvathukal, @jamesrhester https://github.com/jamesrhester, @Smattr https://github.com/Smattr, @drj11 https://github.com/drj11 - I want to check on the progress of this review. Is there anything blocking its progress?

— Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/6618#issuecomment-2132840532, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAF2GPWYHNE26CZ4WFQ3ONDZELPJVAVCNFSM6AAAAABGFYPTXWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMZSHA2DANJTGI . You are receiving this because you were mentioned.Message ID: @.***>

-- T +61 (02) 9717 9907 F +61 (02) 9717 3145 M +61 (04) 0249 4148

gkthiruvathukal commented 4 months ago

Thanks, @jamesrhester. Do you have an ETA?

@Smattr, @drj11, can you let us know whether you can complete your review? We need at least two completed reviews to proceed.

Smattr commented 4 months ago

Like jamesrhester, I just haven’t had time yet. My previous comment about not being available until May was not a request to be assigned as a reviewer, assuming I would immediately start May 1 :wink:. I think I should have some time upcoming, but fair warning I have not taken even a cursory glance at the paper yet to see if I’m qualified to review.

drj11 commented 4 months ago

i have been on holiday and i'm back now. i've had a poke around their documentation, and i don't see a problem with proceeding. I'll try it and get it done by Friday. 2024-06-07

gkthiruvathukal commented 4 months ago

Thanks, @Smattr and @drj11. No worries. Happy to have you on board!

Smattr commented 3 months ago

Review checklist for @Smattr

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

Smattr commented 3 months ago

FYI for other reviewers, as per https://github.com/GreycLab/gmic/issues/55#issuecomment-2172312110 apparently we’re supposed to review the release tarball not the current content on Github.

dtschump commented 3 months ago

Just a word on this: The github repository is a "working repository" intended to contain the WIP source code. It contains two branches 'main' and 'develop', but the 'main' branches does not correspond to the state of the latest release. Additionnally, the source code of G'MIC requires additionnal files that are not stored in the gmic repository, so using the code directly from the repository is definitely less practical if you only want to compile (or review) the project code.

dtschump commented 3 months ago

I've updated the "Download" page from the website to reflect this : https://gmic.eu/download.html

jamesrhester commented 3 months ago

Just a note on my approach to reviewing this:

  1. verifying all of the functionality is impractical because there's so much, so I've simply made sure that a few of the demos and sample scripts from the repo work. May have played the 2048 game for longer than strictly necessary.
  2. likewise it is impractical to check all of the supported platforms. As I run Debian, I've installed from a Debian mirror and used the fact that the Debian packager compiles from source to assess that it compiles and installs "by proxy".
jamesrhester commented 3 months ago

I've finished my review now. It was great to find out about some useful software that I can't believe I haven't encountered before. Sorry it took a bit longer than planned.

danielskatz commented 2 months ago

👋 @gkthiruvathukal - As track editor, I try to check in on reviews where nothing has happened in a couple of weeks. How is this going? And can I do anything to help it move forward?

Smattr commented 2 months ago

From my side, the only blocker is just finding the time to continue my review.

gkthiruvathukal commented 2 months ago

@Smattr Can you give us an idea of when you may be able to complete the review?

Smattr commented 2 months ago

Taking another run at this just now, I still can’t get this project to build. https://github.com/GreycLab/gmic/issues/60. Unless I can compile this software, I’m not sure how I can review it.

gkthiruvathukal commented 2 months ago

@Smattr Thanks for this. Not being able to compile is a blocker.

@dtschump Can you please follow up as soon as possible?

dtschump commented 2 months ago

I'm just back from vacations. I'll check that ASAP.

Smattr commented 1 month ago

Sorry for the delay once again with this. I had another attempt using the alternate instructions from @dtschump. Unfortunately I still can’t get this project to build.

I’d like to request to step down as a reviewer. I’ve had 3+ attempts at compiling this project and been unsuccessful. @dtschump has been very helpful and FWIW the problems may be entirely on my side. I’m a C++ dev myself and could probably try and debug this but, to be frank, this is not what I signed up for. I think given my limited availability and blockers here, it’s better to let someone else take over who may be able to progress this.

I’d like to highlight that none of this is a judgement on the quality of G’MIC. From where I reached in my review, I have the impression it is a mature and impressive project, for which a JOSS submission is somewhat of an afterthought – JOSS would be enriched by the inclusion of G’MIC, but G’MIC seems already very successful independent of this.

gkthiruvathukal commented 1 month ago

@Smattr Thanks for your input. I actually see this as a major blocker if you have not been able to get this to compile. Other users are likely to encounter endless frustration, which will limit the impact of the contribution. Please don't step down. We value the time of our reviewers. At this point, your input/review is complete, since you gave us a clear statement about what improvements are needed.

Although I fully appreciate @dtschump's efforts to be helpful, this is not a key criterion for recommending acceptance. Everything starts with the ability to compile and run the code.

@jamesrhester can you confirm that as part of your review that you were able to successfully compile the code? This is crucial for me to make a recommendation how to proceed.

Smattr commented 1 month ago

I think this comment from jamesrhester explains:

I … used the fact that the Debian packager compiles from source to assess that it compiles and installs "by proxy".

jamesrhester commented 1 month ago

Yes, @Smattr is correct. If Debian provides the software then I am satisfied that it can be independently compiled from source. The only patch from Debian is to allow clang to be used as well.

If this is not satisfactory for JOSS happy to have a go at compiling it myself.

gkthiruvathukal commented 1 month ago

@jamesrhester I am mostly in agreement here. If this package can be installed from Debian, this might be satisfactory. However, I would like to know whether it is installable from the central repository or a PPA.

And if anyone has been able to build it, I could also be satisfied with a video showing all steps being executed successfully or even an Asciinema screencast.

Lastly, even something like a Homebrew formula would do.

stefantalpalaru commented 1 month ago

even something like a Homebrew formula would do

How about a Gentoo ebuild, instead?

https://github.com/stefantalpalaru/gentoo-overlay/tree/master/media-gfx/gmic

Build log: https://gist.github.com/stefantalpalaru/b342401125af0b3329cf86108932f402