openjournals / joss-reviews

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

[PRE REVIEW]: CÆLUM: An academic High-Order Finite-Volume solver for the compressible Euler equations and related models #7373

Open editorialbot opened 1 week ago

editorialbot commented 1 week ago

Submitting author: !--author-handle-->@navasmontilla<!--end-author-handle-- (Adrian Navas Montilla) Repository: https://github.com/navasmontilla/CAELUM Branch with paper.md (empty if default branch): Version: v1.0 Editor: Pending Reviewers: Pending Managing EiC: Kyle Niemeyer

Status

status

Status badge code:

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

Author instructions

Thanks for submitting your paper to JOSS @navasmontilla. Currently, there isn't a JOSS editor assigned to your paper.

@navasmontilla if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands
editorialbot commented 1 week ago

Hello human, 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.1002/fld.3767 is OK
- 10.1016/j.cpc.2023.108700 is OK
- 10.1017/CBO9780511618604 is OK
- 10.1016/j.jcp.2023.112273 is OK
- 10.1016/j.compfluid.2024.106349 is OK
- 10.4208/cicp.291109.080410s is OK
- 10.1006/jcph.1996.0130 is OK
- 10.1016/j.cpc.2019.06.013 is OK
- 10.1016/j.jcp.2007.12.009 is OK
- 10.1137/S003614450036757X is OK
- 10.1137/S1064827595291819 is OK
- 10.1016/j.jcp.2021.110246 is OK
- 10.1016/j.compfluid.2015.04.026 is OK
- 10.1016/j.cpc.2018.10.009 is OK
- 10.2514/1.J054580 is OK
- 10.1016/j.cpc.2021.108063 is OK
- 10.1016/j.cpc.2020.107262 is OK
- 10.1016/j.cpc.2022.108527 is OK
- 10.1016/j.cpc.2023.108717 is OK
- 10.1063/5.0147457 is OK
- 10.1029/2023MS003732 is OK
- 10.1016/j.cpc.2022.108453 is OK
- 10.48550/arXiv.2404.12703 is OK
- 10.1016/j.cpc.2021.107906 is OK
- 10.21105/joss.06448 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: HyPar Repository (https://github.com/debog/hypar)

❌ MISSING DOIs

- None

❌ INVALID DOIs

- 10.1177/10943420155768 is INVALID
editorialbot commented 1 week ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.07 s (801.6 files/s, 204144.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
C                                9           1058            402           3485
Python                          19            929            739           2438
Markdown                        14            534              0           1486
Jupyter Notebook                 4              0           2687            618
TeX                              1             41              0            266
C/C++ Header                    10            146            119            221
make                             1             17             29             36
YAML                             2              1              4             24
-------------------------------------------------------------------------------
SUM:                            60           2726           3980           8574
-------------------------------------------------------------------------------

Commit count by author:

   299  Adrian
    15  javier78gh
editorialbot commented 1 week ago

Paper file info:

📄 Wordcount for paper.md is 1502

✅ The paper includes a Statement of need section

editorialbot commented 1 week ago

License info:

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

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:

editorialbot commented 1 week ago

Five most similar historical JOSS papers:

RHEA: an open-source Reproducible Hybrid-architecture flow solver Engineered for Academia Submitting author: @lluisjofre Handling editor: @diehlpk (Active) Reviewers: @ctdegroot, @thomasgillis Similarity score: 0.8089

OpenCMP: An Open-Source Computational Multiphysics Package Submitting author: @nasserma Handling editor: @lucydot (Active) Reviewers: @bonh, @WilkAndy Similarity score: 0.7903

Ocellaris: a DG FEM solver for free-surface flows Submitting author: @TormodLandet Handling editor: @labarba (Retired) Reviewers: @inducer, @piyueh Similarity score: 0.7738

Coral: a parallel spectral solver for fluid dynamics and partial differential equations Submitting author: @benmql Handling editor: @eloisabentivegna (Retired) Reviewers: @robertsawko, @rhaas80 Similarity score: 0.7627

PeleLMeX: an AMR Low Mach Number Reactive Flow Simulation Code without level sub-cycling Submitting author: @esclapez Handling editor: @kyleniemeyer (Active) Reviewers: @mameehan5, @xzz105, @muellerm-pu Similarity score: 0.7597

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

kyleniemeyer commented 1 week ago

Hello @navasmontilla, we will use this issue to assign an editor and find reviewers.

Before assigning an editor, I noticed that your project's README is extremely long, and seems to contain essentially all the documentation. I strongly recommend that you reduce the length of the README to basic overview and use/installation instructions, and create a dedicated documentation website/webpages. This will almost certainly be a request from reviewers.

kyleniemeyer commented 1 week ago

@navasmontilla can you please respond and address my above request? Otherwise, I will have to reject this for lack of response/activity. Thanks!

navasmontilla commented 1 week ago

Dear @kyleniemeyer,

I am sorry for the delay in my reply. I could not upload the proposed changes earlier. Following your instructions, I have reduced the length of the README file. It now includes an introduction, installation/use instructions, and the community guidelines and license. I have moved the section containing the example cases and the functionality documentation to other files and included the links to them in the README file

Please let me know if it is ok in its present form.

Thank you very much for your assistance.

Adrián