[REVIEW]: PyPEEC: A 3D Quasi-Magnetostatic Solver using an FFT-Accelerated PEEC Method with Voxelization

[editorialbot]

Submitting author: @otvam (Thomas Guillod)
Repository: https://github.com/otvam/pypeec
Branch with paper.md (empty if default branch): paper_joss
Version: v4.8.0
Editor: @likeajumprope
Reviewers: @thelfer
Archive: Pending

Status

Status badge code:

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

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

@thelfer, 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 @likeajumprope 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 @thelfer

[editorialbot]

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]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.03 s (182.7 files/s, 323962.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
SVG                              2              2              2          10273
TeX                              1             17              0            157
Markdown                         1             24              0            129
YAML                             1              2              0             19
Bourne Shell                     1              3              2              8
-------------------------------------------------------------------------------
SUM:                             6             48              4          10586
-------------------------------------------------------------------------------

Commit count by author:

     4	Thomas Guillod

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 1002

✅ The paper includes a Statement of need section

[editorialbot]

License info:

🔴 Failed to discover a valid open source license

[editorialbot]

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

OK DOIs

- None

MISSING DOIs

- 10.6028/jres.069c.016 may be a valid DOI for title: Exact Inductance Equations for Rectangular Conduct...
- 10.2528/pierm12080314 may be a valid DOI for title: Exact Closed Form Formula for Self Inductance of C...
- 10.1109/tpel.2021.3092431 may be a valid DOI for title: FFT-PEEC: A Fast Tool From CAD to Power Electronic...
- 10.1016/j.jcp.2014.03.026 may be a valid DOI for title: Stable FFT-JVIE Solvers for Fast Analysis of Highl...
- 10.1016/0885-064x(86)90007-5 may be a valid DOI for title: Fast Multiplication of a Recursive Block Toeplitz ...
- 10.1109/temc.2023.3238394 may be a valid DOI for title: Efficient PEEC Iterative Solver for Power Electron...
- 10.1109/tmtt.1974.1128204 may be a valid DOI for title: Equivalent Circuit Models for Three-Dimensional Mu...
- 10.1109/tap.2019.2927789 may be a valid DOI for title: A Volume PEEC Formulation Based on the Cell Method...
- 10.1109/tmtt.2017.2785842 may be a valid DOI for title: VoxHenry: FFT-Accelerated Inductance Extraction fo...
- 10.1088/1361-6587/abce8f may be a valid DOI for title: Fast Fourier Transform-Volume Integral: a Smart Ap...
- 10.1016/j.cmpb.2021.106543 may be a valid DOI for title: A Fast Tool for the Parametric Analysis of Human B...
- 10.1109/iceccme52200.2021.9590864 may be a valid DOI for title: Application of FFT-PEEC Method for Nonlinear Induc...
- 10.1109/icemic.2003.1287800 may be a valid DOI for title: A Review on Computational EMI Modelling Techniques
- No DOI given, and none found for title: FFT-PEEC
- No DOI given, and none found for title: FFT-NLIE
- No DOI given, and none found for title: VoxHenry
- No DOI given, and none found for title: MARIE

INVALID DOIs

- None

[editorialbot]

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

[otvam]

Hi,

I just wanted to ask if there is any progress for the review. The issue about the installation of PyPEEC has been solved (see otvam/pypeec#5).

[thelfer]

Hi @otvam, thanks. The review is more or less stalled du to my professional duties, my apologies. I'll try to catch up as soon as possible. To my knowledge, no another reviewer been found, right ?

[thelfer]

Review checklist for @thelfer

Conflict of interest

• 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

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the https://github.com/otvam/pypeec?
• License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
• Contribution and authorship: Has the submitting author (@otvam) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
• Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
• 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.
• Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
• 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

• 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?

[thelfer]

@editorialbot generate pdf

[editorialbot]

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

[likeajumprope]

Hi @otvam, thanks. The review is more or less stalled du to my professional duties, my apologies. I'll try to catch up as soon as possible. To my knowledge, no another reviewer been found, right ?

I am still actively looking for another reviewer - had some no -replies but will keep looking

[thelfer]

@likeajumprope On my side, professional duties did not allow me to complete the review so far. First impressions on the paper and the project are good (although this is by no way my scientific field of expertise, so I can hardly judge fairly), I feel a bit ashamed.

[likeajumprope]

@likeajumprope On my side, professional duties did not allow me to complete the review so far. First impressions on the paper and the project are good (although this is by no way my scientific field of expertise, so I can hardly judge fairly), I feel a bit ashamed.

No problem at all, @thelfer. The effort is very much appreciated regardless, so don't worry!

[thelfer]

@likeajumprope Issues related to the review:

• [joss review] python requirements ? otvam/pypeec#5 (installation, closed)
• [JOSS review] Various questions otvam/pypeec#7 (questions related to the JOSS acceptance criteria)