[PRE REVIEW]: foamlib: A modern Python package for working with OpenFOAM

[editorialbot]

Submitting author: @gerlero (Gabriel S. Gerlero)
Repository: https://github.com/gerlero/foamlib
Branch with paper.md (empty if default branch): joss
Version: v0.7.0
Editor: @mbarzegary
Reviewers: Pending
Managing EiC: Kyle Niemeyer

Status

Status badge code:

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

Author instructions

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

@gerlero 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]

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]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.04 s (1238.0 files/s, 127236.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          24            636            140           2717
YAML                             7             19              4            343
Markdown                         2            104              0            210
TOML                             3             13              0            113
TeX                              1              8              0             68
DOS Batch                        1              8              1             26
Dockerfile                       1             11              1             16
JSON                             1              0              0             16
reStructuredText                 3             12             25             11
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                            44            815            178           3529
-------------------------------------------------------------------------------

Commit count by author:

   340	Gabriel Gerlero
     5	dependabot[bot]
     3	Ali Bozorgzadeh

[editorialbot]

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

✅ OK DOIs

- 10.1016/j.cpc.2021.108143 is OK
- 10.1016/j.talo.2024.100350 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: mypy: Optional static typing for Python
- No DOI given, and none found for title: OpenFOAM.app: Native OpenFOAM for macOS
- No DOI given, and none found for title: PyFoam: Python Utilities for OpenFOAM
- No DOI given, and none found for title: pyparsing: Python library for creating PEG parsers
- No DOI given, and none found for title: pytest 8.3
- No DOI given, and none found for title: pytest-asyncio-cooperative: Run all your asynchron...
- No DOI given, and none found for title: reagency: A simple, extensible reaction model for ...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 2102

✅ The paper includes a Statement of need section

[editorialbot]

License info:

🟡 License found: GNU General Public License v3.0 (Check here for OSI approval)

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[editorialbot]

Five most similar historical JOSS papers:

pylattica: a package for prototyping lattice models in chemistry and materials science
Submitting author: @mcgalcode
Handling editor: @richardjgowers (Retired)
Reviewers: @riesben, @amkrajewski
Similarity score: 0.6162

BoxKit: A Python library to manage analysis of block-structured simulation datasets
Submitting author: @akashdhruv
Handling editor: @kellyrowland (Active)
Reviewers: @rvg296, @Abinashbunty
Similarity score: 0.6117

flowTorch - a Python library for analysis and reduced-order modeling of fluid flows
Submitting author: @AndreWeiner
Handling editor: @Kevin-Mattheus-Moerman (Active)
Reviewers: @akaptano, @JaroslavHron, @salrm8, @hkjeldsberg
Similarity score: 0.6113

Snek5000: a new Python framework for Nek5000
Submitting author: @paugier
Handling editor: @philipcardiff (Active)
Reviewers: @joneuhauser, @maxhutch
Similarity score: 0.6090

NIMPHS: Numerous Instruments to Manipulate and Post-process Hydraulic Simulations
Submitting author: @Failxxx
Handling editor: @hugoledoux (Active)
Reviewers: @vbassn, @liberostelios
Similarity score: 0.6079

⚠️ 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]

Hello @gerlero, thanks for your submission to JOSS. We're currently managing a large backlog of submissions and the editor most appropriate for your area is already rather busy.

While we are waiting, could you please some potential reviewers from our database? (Please do not actually tag them with @ though)

For now, we will need to waitlist this paper and process it as the queue reduces. Thanks for your patience!

[gerlero]

While we are waiting, could you please some potential reviewers from our database? (Please do not actually tag them with @ though)

Possible reviewers in database:

• MakisH
• chennachaos

More possible reviewers (JOSS paper authors not in database):

• philipcardiff
• blebon

For now, we will need to waitlist this paper and process it as the queue reduces. Thanks for your patience!

Thank you!

[mbarzegary]

@editorialbot assign me as editor

[editorialbot]

Assigned! @mbarzegary is now the editor

[gerlero]

Hi @mbarzegary!
For disclosure, while expecting a longer waitlist period, we've made some updates to the package and released new versions since our submission. If you prefer, we can quickly update the paper to align with the changes in the latest version (0.8.1), or you’re of course welcome to proceed with reviewing the paper as initially submitted, which as stated corresponds to version 0.7.0 of the package. Let us know what works best for you.