[PRE REVIEW]: kifmm-rs: A Kernel Independent Fast Multipole Framework in Rust

[editorialbot]

Submitting author: !--author-handle-->@skailasa<!--end-author-handle-- (Srinath Kailasa) Repository: https://github.com/bempp/kifmm/ Branch with paper.md (empty if default branch): main Version: v1.0.0 Editor: !--editor-->@diehlpk<!--end-editor-- Reviewers: @AntoineJkl, @rfj82982, @jeremiah-corrado Managing EiC: Daniel S. Katz

Status

Status badge code:

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

Author instructions

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

@skailasa 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.09 s (1062.2 files/s, 424037.9 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Rust                            68           3548           3194          19179
SVG                              1              0             12           9011
Python                           2            152            113            666
XML                              2              0              0            466
Jupyter Notebook                 3              0            609            258
C/C++ Header                     2             35            584            244
Markdown                         4             74              0            204
TeX                              1             16              0            183
TOML                             7             30              2            153
YAML                             3             12              0            145
C                                1             21              3             97
Bourne Shell                     2              0              0             73
CMake                            1              6              0             18
HTML                             1              0              0             15
-------------------------------------------------------------------------------
SUM:                            98           3894           4517          30712
-------------------------------------------------------------------------------

Commit count by author:

   124  Matthew Scroggs
    73  Srinath Kailasa
    21  Timo Betcke

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 2004

✅ The paper includes a Statement of need section

[editorialbot]

License info:

✅ License found: BSD 3-Clause "New" or "Revised" License (Valid open source OSI approved license)

[editorialbot]

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

OK DOIs

- 10.1051/0004-6361/201629272 is OK
- 10.1051/0004-6361/201322068 is OK
- 10.1016/j.jcp.2003.11.021 is OK
- 10.1016/j.jcp.2009.08.031 is OK
- 10.4208/cicp.020215.150515sw is OK
- 10.1016/0021-9991(87)90140-9 is OK

MISSING DOIs

- No DOI given, and none found for title: Gaps in Globular Cluster Streams: Pal 5 and the Ga...
- No DOI given, and none found for title: Galactic Dynamics: Second Edition
- No DOI given, and none found for title: Fidgit: An ungodly union of GitHub and Figshare
- No DOI given, and none found for title: The best of the 20th century: Editors name top 10 ...
- No DOI given, and none found for title: The landscape of parallel computing research: A vi...
- 10.21105/joss.03145 may be a valid DOI for title: ExaFMM: a high-performance fast multipole method l...
- No DOI given, and none found for title: M2L Translation operators for kernel independent f...
- 10.1016/j.cam.2009.08.036 may be a valid DOI for title: Fast directional algorithms for the Helmholtz kern...
- No DOI given, and none found for title: Numerical approximation methods for elliptic bound...
- No DOI given, and none found for title: Bempp-rs: Boundary element methods in Rust
- No DOI given, and none found for title: RLST: A Linear Algebra Library in Rust
- No DOI given, and none found for title: pulp: A safe abstraction over SIMD instructions

INVALID DOIs

- None

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

FEM_2D: A Rust Package for 2D Finite Element Method Computations with Extensive Support for hp-refinement Submitting author: @jeremiah-corrado Handling editor: @jedbrown (Active) Reviewers: @jeremylt, @YohannDudouit Similarity score: 0.7683

ExaFMM: a high-performance fast multipole method library with C++ and Python interfaces Submitting author: @tingyu66 Handling editor: @poulson (Retired) Reviewers: @berenger-eu, @pitsianis Similarity score: 0.7549

Bempp-cl: A fast Python based just-in-time compiling boundary element library. Submitting author: @mscroggs Handling editor: @meg-simula (Retired) Reviewers: @jamtrott, @ramisetti Similarity score: 0.7079

RustBCA: A High-Performance Binary-Collision-Approximation Code for Ion-Material Interactions Submitting author: @drobnyjt Handling editor: @arfon (Active) Reviewers: @HaoZeke, @joglekara Similarity score: 0.7073

The 2DECOMP&FFT library: an update with new CPU/GPU capabilities Submitting author: @rfj82982 Handling editor: @diehlpk (Active) Reviewers: @CeciliaCoelho, @p-costa Similarity score: 0.7069

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

[danielskatz]

👋 @skailasa - thanks for your submission.

I have a few comments initially:

1. The paper is about 2000 words, while JOSS papers are typically closer to 1000 maximum. You should probably move some of the papers content to the repo/documentation, and point at it there.
2. I see 4 contributors to the repo, but you are the only author. Can you say why this is?
3. In the README, you will need to add some information on contributing to the software; this is in the JOSS review criteria
4. I don't know much about Rust packaging, so I am unsure if you are following best practices in this regard

While you consider these comments, and work on shortening the paper, I'll try to find an editor

[danielskatz]

👋 @diehlpk - Would you be able to edit this submission?

[danielskatz]

@editorialbot invite @diehlpk as editor

[editorialbot]

Invitation to edit this submission sent!

[skailasa]

Hi Daniel

👋 @skailasa - thanks for your submission.

I have a few comments initially:

1. The paper is about 2000 words, while JOSS papers are typically closer to 1000 maximum. You should probably move some of the papers content to the repo/documentation, and point at it there.

Sure I can do this, thank you

2. I see 4 contributors to the repo, but you are the only author. Can you say why this is?

This code has been extracted out of a larger mono-repo in order to expose functionality in a simpler way to related projects, the contributors to the mono repo are a part of the commit history which we did not want to delete, whereas I am the dominant contributor to the code as presented in this repo, aside from small bug fixes or comments.

3. In the README, you will need to add some information on contributing to the software; this is in the JOSS review criteria

Sure I will update this

4. I don't know much about Rust packaging, so I am unsure if you are following best practices in this regard

I will update the README with clearer build instructions.

While you consider these comments, and work on shortening the paper, I'll try to find an editor

[skailasa]

Hi @danielskatz , I've responded to your questions on my repo, is this automatically updated in the submission?

[danielskatz]

The submission is connected to the repo, so yes on that. If you've made paper changes, you can rebuild the paper, check the length, and check the references with editorialbot commands. Each command should be the first thing in a new comment. Use @editorialbot commands to see what the commands are

[skailasa]

@editorialbot commands

[editorialbot]

Hello @skailasa, here are the things you can ask me to do:

# List all available commands
@editorialbot commands

# Get a list of all editors's GitHub handles
@editorialbot list editors

# Adds a checklist for the reviewer using this command
@editorialbot generate my checklist

# Set a value for branch
@editorialbot set joss-paper as branch

# Run checks and provide information on the repository and the paper file
@editorialbot check repository

# Check the references of the paper for missing DOIs
@editorialbot check references

# Generates the pdf paper
@editorialbot generate pdf

# Generates a LaTeX preprint file
@editorialbot generate preprint

# Get a link to the complete list of reviewers
@editorialbot list reviewers

[skailasa]

@editorialbot generate pdf

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

TBFMM: A C++ generic and parallel fast multipole method library Submitting author: @berenger-eu Handling editor: @poulson (Retired) Reviewers: @pitsianis, @Himscipy, @sarats Similarity score: 0.7435

FLAM: Fast Linear Algebra in MATLAB - Algorithms for Hierarchical Matrices Submitting author: @klho Handling editor: @melissawm (Retired) Reviewers: @sivaramambikasaran, @pitsianis, @vijaysm Similarity score: 0.7370

FEM_2D: A Rust Package for 2D Finite Element Method Computations with Extensive Support for hp-refinement Submitting author: @jeremiah-corrado Handling editor: @jedbrown (Active) Reviewers: @jeremylt, @YohannDudouit Similarity score: 0.7234

The 2DECOMP&FFT library: an update with new CPU/GPU capabilities Submitting author: @rfj82982 Handling editor: @diehlpk (Active) Reviewers: @CeciliaCoelho, @p-costa Similarity score: 0.7123

$hp\mathrm{3D}$: A Scalable MPI/OpenMP $hp$-Adaptive Finite Element Software Library for Complex Multiphysics Applications Submitting author: @stefanhenneking Handling editor: @jedbrown (Active) Reviewers: @peterrum, @likask Similarity score: 0.7087

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

[skailasa]

@editorialbot check repository

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.09 s (1062.2 files/s, 426013.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Rust                            68           3548           3196          19179
SVG                              1              0             12           9011
Python                           2            152            113            666
XML                              2              0              0            403
C/C++ Header                     2             35            584            244
Jupyter Notebook                 2              0            539            231
Markdown                         4             87              0            215
TOML                             7             30              2            153
YAML                             3             12              0            145
TeX                              1             13              0            101
C                                1             21              3             97
Bourne Shell                     2              0              0             73
CMake                            1              6              0             18
HTML                             1              0              0             15
-------------------------------------------------------------------------------
SUM:                            97           3904           4449          30551
-------------------------------------------------------------------------------

Commit count by author:

   124  Matthew Scroggs
    76  Srinath Kailasa
    21  Timo Betcke

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 1060

✅ The paper includes a Statement of need section

[editorialbot]

License info:

✅ License found: BSD 3-Clause "New" or "Revised" License (Valid open source OSI approved license)

[diehlpk]

@editorialbot add @diehlpk as editor

[editorialbot]

Assigned! @diehlpk is now the editor

[diehlpk]

Hi @berenger-eu do you have time to review this paper?

[diehlpk]

Hi @klho do you have time to review this paper?

[diehlpk]

HI @jeremiah-corrado do you have time to review this paper?

[klho]

@diehlpk - Sorry, I won't be able do this.

[berenger-eu]

Hi, I will confirm in a few days (I may find someone working on the fmm too who could do it, if not I will evaluate my availability).

[berenger-eu]

So I would suggest @AntoineJkl instead of myself. Antoine agreed to review, and he has a good expertise on the FMM.

[diehlpk]

@editorialbot add @AntoineJkl as reviewer

[editorialbot]

@AntoineJkl added to the reviewers list!

[diehlpk]

Hi @rfj82982 do you have time to review this paper?

[diehlpk]

Hi @kvenkman do you have time to review this paper?

[diehlpk]

Hi @borgesaugusto do you have time to review this paper?

[rfj82982]

Hi @rfj82982 do you have time to review this paper?

Hi @diehlpk I can review the paper, but only after the end of September. If the review can wait for beginning of October I'll be happy to do it.

[kvenkman]

hi @diehlpk - this work falls out of my area of expertise, and so I won't be well suited as a reviewer.

[diehlpk]

@editorialbot add @rfj82982 as reviewer

[editorialbot]

@rfj82982 added to the reviewers list!

[diehlpk]

Hi @rfj82982 do you have time to review this paper?

Hi @diehlpk I can review the paper, but only after the end of September. If the review can wait for beginning of October I'll be happy to do it.

Yes, that is fine.

[jeremiah-corrado]

Hi @diehlpk, I can review.

[diehlpk]

@editorialbot add @rfj82982 as reviewer

[editorialbot]

@rfj82982 is already included in the reviewers list

[diehlpk]

@editorialbot add @jeremiah-corrado as reviewer

[editorialbot]

@jeremiah-corrado added to the reviewers list!

[diehlpk]

@editorialbot start review

[editorialbot]

OK, I've started the review over in https://github.com/openjournals/joss-reviews/issues/7124.