search

openjournals / joss-reviews

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

[REVIEW]: An Open-Source Tool for Generating Domain-Specific Accelerators for Resource-Constrained Computing #6825

Closed editorialbot closed 1 month ago

editorialbot commented 6 months ago

Submitting author: !--author-handle-->@dtkerns<!--end-author-handle-- (David Kerns) Repository: https://github.com/dtkerns/d2 Branch with paper.md (empty if default branch): Version: v1.0.0-pub Editor: !--editor-->@gkthiruvathukal<!--end-editor-- Reviewers: @manuel-g-castro, @abhishektiwari Archive: 10.5281/zenodo.13926674

Status

status

Status badge code:

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

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

@manuel-g-castro & @abhishektiwari, 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 @abhishektiwari

📝 Checklist for @manuel-g-castro

editorialbot commented 6 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 6 months ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.02 s (1605.8 files/s, 134199.0 lines/s)
--------------------------------------------------------------------------------
Language                      files          blank        comment           code
--------------------------------------------------------------------------------
C++                               2             36             63            652
Bourne Again Shell               11             32             48            649
Python                           10             37             49            540
Markdown                          4             95              0            321
TeX                               1             16              1            173
C                                 2              7              0             77
make                              4             29              0             77
YAML                              1              1              4             18
--------------------------------------------------------------------------------
SUM:                             35            253            165           2507
--------------------------------------------------------------------------------

Commit count by author:

    83  dtkerns
    40  David T Kerns
     8  tosiron
editorialbot commented 6 months ago

Paper file info:

📄 Wordcount for paper.md is 1224

✅ The paper includes a Statement of need section

editorialbot commented 6 months ago

License info:

✅ License found: MIT License (Valid open source OSI approved license)

editorialbot commented 6 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1145/3282307 is OK
- 10.1145/968280.968304 is OK
- 10.1145/2514740 is OK
- 10.1109/ISLPED52811.2021.9502501 is OK
- 10.1109/JIOT.2018.2849859 is OK
- 10.1109/32.221135 is OK
- 10.1109/WWC.2001.990739 is OK
- 10.1109/ISCA45697.2020.00041 is OK
- 10.1145/2024716.2024718 is OK
- 10.1109/HPCA.2017.59 is OK

MISSING DOIs

- No DOI given, and none found for title: Introduction to FPGA Design with Vivado High-Level...
- No DOI given, and none found for title: Drawing graphs with dot
- No DOI given, and none found for title: LLVM Language Reference Manual
- No DOI given, and none found for title: LLVM Language Reference Manual
- No DOI given, and none found for title: Meld Visual diff and merge tool
- No DOI given, and none found for title: C++ Standard Template Library

INVALID DOIs

- None
editorialbot commented 6 months ago

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

abhishektiwari commented 5 months ago

Review checklist for @abhishektiwari

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

danielskatz commented 5 months ago

@abhishektiwari - it looks like your issues have been responded to. Can they be closed, and can you move the review forward? (I'm writing as track editor, checking on reviews without progress in the last 2 weeks)

dtkerns commented 4 months ago

Should I close those two issues? I was waiting for a follow-up comment from the originator.

gkthiruvathukal commented 4 months ago

@dtkerns Yes, let's wait for the originator @abhishektiwari to follow-up. Then you can close them if resolved to their satisfaction.

@manuel-g-castro, will you also be able to add your review soon?

abhishektiwari commented 4 months ago

@dtkerns I am down to final review criteria - Automated tests. Please see my recommendations here. I think this is a small change to automate existing example to run with every commit without too much of rework.

abhishektiwari commented 4 months ago

@gkthiruvathukal tool has performance benchmark under the paper/appendix.md of repository. Is JOSS guidance to register benchmark results with a separate ZENODO archive or its ok to be keep it part of repository ZENODO archive?

danielskatz commented 3 months ago

@abhishektiwari - I'll step in for @gkthiruvathukal and mention that either is ok.

gkthiruvathukal commented 3 months ago

@abhishektiwari As @danielskatz mentioned, it is ok. Any service with a stable DOI will do.

manuel-g-castro commented 3 months ago

@dtkerns Yes, let's wait for the originator @abhishektiwari to follow-up. Then you can close them if resolved to their satisfaction.

@manuel-g-castro, will you also be able to add your review soon?

Hello, @gkthiruvathukal! I am sorry for my late response. I will start today and hopefully finish by next week my review.

manuel-g-castro commented 3 months ago

Review checklist for @manuel-g-castro

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

abhishektiwari commented 3 months ago

@dtkerns Thanks for adding Github action for testing.

@gkthiruvathukal I have completed the review checklist. Let me know if any questions.

manuel-g-castro commented 3 months ago

@editorialbot generate pdf

editorialbot commented 3 months ago

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

manuel-g-castro commented 3 months ago

hey @dtkerns I will just wait for your comments on the issue that I just opened.

With that done, I think, there is nothing more from my side.

dtkerns commented 3 months ago

I'll let you close the issue when you're happy with the updates (I'm a believer in "the issue opener must be satisfied to close")

On Tue, Aug 27, 2024 at 5:57 AM Manuel G. Marciani @.***> wrote:

hey @dtkerns https://github.com/dtkerns I will just wait for your comments on the issue that I just opened https://github.com/dtkerns/d2/issues/9.

With that done, I think, there is nothing more from my side.

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

manuel-g-castro commented 3 months ago

I'll let you close the issue when you're happy with the updates (I'm a believer in "the issue opener must be satisfied to close") … On Tue, Aug 27, 2024 at 5:57 AM Manuel G. Marciani @.> wrote: hey @dtkerns https://github.com/dtkerns I will just wait for your comments on the issue that I just opened <dtkerns/d2#9>. With that done, I think, there is nothing more from my side. — Reply to this email directly, view it on GitHub <#6825 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADVJRKDYFE5LEOWLVD4E2R3ZTRZTXAVCNFSM6AAAAABIVCPMRCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMJSGQ4TCMZWGA . You are receiving this because you were mentioned.Message ID: @.>

Done! I have nothing else to comment. Nice work!

danielskatz commented 2 months ago

👋 @gkthiruvathukal - what's next to do on this?

gkthiruvathukal commented 2 months ago

@danielskatz I think we're ready to move forward as both reviewers' inputs have been addressed. The final comment came as my semester was starting (always the craziest time in a chairperson's life). I will prepare the final checklist and then move toward acceptance.

danielskatz commented 1 month ago

👋 @gkthiruvathukal - are you now going to move this ahead? (As track editor, I try to check in on reviews where nothing has happened in a couple of weeks.)

danielskatz commented 1 month ago

@editorialbot remind me in 4 days

editorialbot commented 1 month ago

Reminder set for @danielskatz in 4 days

editorialbot commented 1 month ago

:wave: @danielskatz, please take a look at the state of the submission (this is an automated reminder).

danielskatz commented 1 month ago

@dtkerns - I'll take over at this point. I'll next proofread the paper (either Sunday or Monday, most likely), and let you know if I see anything to be changed, then give you instructions on packaging up the files and moving this onward.

gkthiruvathukal commented 1 month ago

@danielskatz Thanks! Per https://github.com/openjournals/joss-reviews/issues/6825#issuecomment-2362679375, I was ready to move forward. My mention of the checklist was a momentary brain lapse where I still was thinking as a track EIC! So please proceed.

danielskatz commented 1 month ago

@gkthiruvathukal - no, you were thinking correctly, in that a checklist would have made sense for you to request to get it ready for me, but since I wasn't sure when you might get to this, I just decided to go ahead, and do things in a different order since I was going to take over the final editor steps as well as doing the AEiC steps.

danielskatz commented 1 month ago

@editorialbot generate pdf

danielskatz commented 1 month ago

@editorialbot check references

editorialbot commented 1 month ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1145/3282307 is OK
- 10.1145/968280.968304 is OK
- 10.1145/2514740 is OK
- 10.1109/ISLPED52811.2021.9502501 is OK
- 10.1109/JIOT.2018.2849859 is OK
- 10.1109/32.221135 is OK
- 10.1109/WWC.2001.990739 is OK
- 10.1109/ISCA45697.2020.00041 is OK
- 10.1145/2024716.2024718 is OK
- 10.1109/HPCA.2017.59 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Introduction to FPGA Design with Vivado High-Level...
- No DOI given, and none found for title: Drawing graphs with dot
- No DOI given, and none found for title: LLVM Language Reference Manual
- No DOI given, and none found for title: LLVM Language Reference Manual
- No DOI given, and none found for title: Meld Visual diff and merge tool
- No DOI given, and none found for title: C++ Standard Template Library

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None
editorialbot commented 1 month ago

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

danielskatz commented 1 month ago

👋 @dtkerns - I've suggested a few minor changes to your paper in https://github.com/dtkerns/d2/pull/10 - please merge this, or let me know what you disagree with, then we can continue.

dtkerns commented 1 month ago

changes merged (thanks) also updated to @.*** per deprecation build error mesage

On Sun, Oct 13, 2024 at 5:01 AM Daniel S. Katz @.***> wrote:

👋 @dtkerns https://github.com/dtkerns - I've suggested a few minor changes to your paper in dtkerns/d2#10 https://github.com/dtkerns/d2/pull/10 - please merge this, or let me know what you disagree with, then we can continue.

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

danielskatz commented 1 month ago

👋 @dtkerns - At this point could you:

I can then move forward with accepting the submission.

dtkerns commented 1 month ago

tag v1.0.0 It looks like I'm Publishing in Zenodo ... want to make sure I'm doing it correctly, is there a different way of creating an archive?

On Sun, Oct 13, 2024 at 7:01 AM Daniel S. Katz @.***> wrote:

👋 @dtkerns https://github.com/dtkerns - At this point could you:

  • Make a tagged release of your software, and list the version tag of the archived version here.
  • Archive the reviewed software in Zenodo or a similar service (e.g., figshare, an institutional repository)
  • Check the archival deposit (e.g., in Zenodo) has the correct metadata. This includes the title (should match the paper title) and author list (make sure the list is correct and people who only made a small fix are not on it). You may also add the authors' ORCID.
  • Please list the DOI of the archived version here.

I can then move forward with accepting the submission.

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

danielskatz commented 1 month ago

You can do this however you would like, but the easiest way is probably to use the GitHub - Zenodo link described in https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content

dtkerns commented 1 month ago

DOI

10.5281/zenodo.13926674

On Sun, Oct 13, 2024 at 11:18 AM Daniel S. Katz @.***> wrote:

You can do this however you would like, but the easiest way is probably to use the GitHub - Zenodo link described in https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content

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

dtkerns commented 1 month ago

oh , and zenodo made me make a new tag, so v1.0.0-pub

On Sun, Oct 13, 2024 at 11:35 AM david kerns @.***> wrote:

DOI

10.5281/zenodo.13926674

On Sun, Oct 13, 2024 at 11:18 AM Daniel S. Katz @.***> wrote:

You can do this however you would like, but the easiest way is probably to use the GitHub - Zenodo link described in https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content

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

danielskatz commented 1 month ago

@editorialbot set 10.5281/zenodo.13926674 as archive

editorialbot commented 1 month ago

Done! archive is now 10.5281/zenodo.13926674

danielskatz commented 1 month ago

@editorialbot set v1.0.0-pub as version

editorialbot commented 1 month ago

Done! version is now v1.0.0-pub

danielskatz commented 1 month ago

@dtkerns - please change the metadata for the archive so that the title and authors match those of the paper. (You don't need to create a new version or new DOI for this; you can do it via editing the Zenodo archive's metadata - see https://help.zenodo.org/docs/deposit/manage-records/)

danielskatz commented 1 month ago

@editorialbot recommend-accept

editorialbot commented 1 month ago 
Attempting dry run of processing paper acceptance...
editorialbot commented 1 month ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1145/3282307 is OK
- 10.1145/968280.968304 is OK
- 10.1145/2514740 is OK
- 10.1109/ISLPED52811.2021.9502501 is OK
- 10.1109/JIOT.2018.2849859 is OK
- 10.1109/32.221135 is OK
- 10.1109/WWC.2001.990739 is OK
- 10.1109/ISCA45697.2020.00041 is OK
- 10.1145/2024716.2024718 is OK
- 10.1109/HPCA.2017.59 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Introduction to FPGA Design with Vivado High-Level...
- No DOI given, and none found for title: Drawing graphs with dot
- No DOI given, and none found for title: LLVM Language Reference Manual
- No DOI given, and none found for title: LLVM Language Reference Manual
- No DOI given, and none found for title: Meld Visual diff and merge tool
- No DOI given, and none found for title: C++ Standard Template Library

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None