[REVIEW]: MQT Core: The Backbone of the Munich Quantum Toolkit (MQT)

editorialbot commented 1 week ago

Submitting author: !--author-handle-->@burgholzer@danielskatz<!--end-editor-- Reviewers: @1ucian0, @edyounis, @josh146 Archive: Pending

Status

Status badge code:

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

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

@1ucian0 & @edyounis & @josh146, 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 @danielskatz 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 @josh146

editorialbot commented 1 week 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 1 week ago

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1109/TCAD.2020.3032630 is OK
- 10.1007/978-3-030-79837-6_14 is OK
- 10.23919/DATE54114.2022.9774631 is OK
- 10.1109/QCE52317.2021.00037 is OK
- 10.1109/ASP-DAC47756.2020.9045153 is OK
- 10.1109/ASP-DAC52403.2022.9712555 is OK
- 10.1109/DAC18072.2020.9218563 is OK
- 10.1145/3394885.3431590 is OK
- 10.1109/TCAD.2022.3197969 is OK
- 10.1109/QCE49297.2020.00051 is OK
- 10.1145/3505636 is OK
- 10.22331/q-2020-06-04-279 is OK
- 10.1109/VLSID57277.2023.00068 is OK
- 10.1145/3400302.3415622 is OK
- 10.1109/TCAD.2022.3182628 is OK
- 10.23919/DATE51398.2021.9474135 is OK
- 10.23919/DATE51398.2021.9474034 is OK
- 10.1145/3530776 is OK
- 10.1109/ASP-DAC47756.2020.9045711 is OK
- 10.1145/3394885.3431604 is OK
- 10.1109/DAC18072.2020.9218555 is OK
- 10.1109/QCE57702.2023.00095 is OK
- 10.1145/3489517.3530480 is OK
- 10.1145/3566097.3567932 is OK
- 10.1109/JETCAS.2022.3202204 is OK
- 10.1145/3593594 is OK
- 10.48550/arXiv.2405.08810 is OK
- 10.1109/QCE57702.2023.00039 is OK
- 10.1088/2058-9565/ad33ac is OK
- 10.48550/arXiv.2311.14164 is OK
- 10.1145/3566097.3567929 is OK
- 10.48550/arXiv.2012.13966 is OK
- 10.1007/978-3-031-15699-1_1 is OK
- 10.1109/ISCAS45731.2020.9180791 is OK
- 10.1109/QSW62656.2024.00013 is OK
- 10.1145/3491246 is OK
- 10.1007/978-981-15-6401-7_43-1 is OK
- 10.23919/DATE51398.2021.9474236 is OK

🟡 SKIP DOIs

- None

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

editorialbot commented 1 week ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.17 s (1657.4 files/s, 333624.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
C++                            120           3917           1474          27688
C/C++ Header                    84           2025           2159          11392
Python                          16           1011           1719           2172
CMake                           32            218            219           1125
Markdown                        14            327              0            837
YAML                            13             50             44            586
TeX                              2             37              0            318
TOML                             1             43              7            254
JSON                             3              0              0            185
HTML                             1              0              0             76
CSS                              1              4              2             47
JSON5                            1              0              1             37
-------------------------------------------------------------------------------
SUM:                           288           7632           5625          44717
-------------------------------------------------------------------------------

Commit count by author:

   951  Lukas Burgholzer
   403  burgholzer
   329  dependabot[bot]
   121  Tom Peham
   116  pre-commit-ci[bot]
    76  Yannick Stade
    55  Stefan Hillmich
    34  renovate[bot]
    14  Thomas Grurl
    14  pehamTom
     7  Aaron Sander
     6  Martin Fink
     4  HartwigB
     4  github-actions
     4  lsschmid
     3  Berti Florea
     2  33Gjl1Xe
     2  Katrin
     2  Parham Rahimi
     2  Rebecca Ghidini
     2  TeWas
     2  Tianyi Wang
     1  Christoph Pichler
     1  Damian Rovara
     1  Elias Leon Foramitti
     1  Hartwig
     1  JoachimMarin
     1  Roope Salmi
     1  Sarah
     1  Thomas
     1  TobiasPrie
     1  p41540

editorialbot commented 1 week ago

Paper file info:

📄 Wordcount for paper.md is 623

✅ The paper includes a Statement of need section

editorialbot commented 1 week ago

License info:

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

editorialbot commented 1 week 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 week ago

@1ucian0 & @edyounis & @josh146 - Thanks for agreeing to review this submission. This is the review thread for the paper. All of our communications will happen here from now on.

As you can see above, you each should use the command @editorialbot generate my checklist to create your review checklist. @editorialbot commands need to be the first thing in a new comment.

As you go over the submission, please check any items that you feel have been satisfied. There are also links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention openjournals/joss-reviews#7478 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for reviews to be completed within about 2-4 weeks. Please let me know if either of you require some more time. We can also use editorialbot (our bot) to set automatic reminders if you know you'll be away for a known period of time.

Please feel free to ping me (@danielskatz) if you have any questions/concerns.

josh146 commented 1 week ago

Review checklist for @josh146

Conflict of interest

[x] I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

[x] I confirm that I read and will adhere to the JOSS code of conduct.

General checks

[x] Repository: Is the source code for this software available at the https://github.com/cda-tum/mqt-core?
[x] License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
[x] Contribution and authorship: Has the submitting author (@burgholzer) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
[x] Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
[x] Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
[x] Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
[x] Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

[x] 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 functionality 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

[ ] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
[ ] A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
[ ] State of the field: Do the authors describe how this software compares to other commonly-used packages?
[ ] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
[ ] References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

danielskatz commented 16 hours ago

👋 @josh146 - thanks for getting started - is there anything blocking your progress (other than time)?

danielskatz commented 16 hours ago

👋 @1ucian0 & @edyounis - Can you also create your checklists (see https://github.com/openjournals/joss-reviews/issues/7478#issuecomment-2474721914 for instructions) and get started with your reviews? Thanks.

openjournals / joss-reviews