kifmm-rs: A Kernel-Independent Fast Multipole Framework in Rust

Install

We currently only support Unix distributions.

The current head can be built from source by adding the following to your Cargo.toml file.

kifmm = { git = "https://github.com/bempp/kifmm" }

The current release version can be installed using the deployment on crates.io, and can be added to your Cargo.toml file with

cargo add kifmm

Quickstart

A quickstart example is available in the kifmm/ directory's README, alongside instructions for building Python bindings or using the C bindings with CMake.

Documentation

The latest documentation of the main branch of this repo is available at bempp.github.io/kifmm/kifmm/index.html.

Build docs with Latex enabled

RUSTDOCFLAGS="--html-in-header kifmm/src/docs-header.html" cargo doc --no-deps

Testing

The functionality of the library can be tested by running:

cargo test

Library

This project uses Rust workspaces to organise the associated crates.

The fftw-src and fftw-sys are responsible for downloading, compiling and linking FFTW 3.9 with custom bindings and build steps. This is currently only available for UNIX systems, and therefore the entire library is also limited to UNIX systems at present.

The kifmm crate contains the source code of the library. This crate contains benchmarks, Rust, Python and C examples for library usage and installation.

The scripts crate contains various useful scripts for examining the performance of the software, used in single node and distributed benchmarks

Additionally, there are a few directories containing metadata for the project. The paper directory contains our JOSS paper, which should be cited for any derivative works based on kifmm-rs.

The hpc directory contains

Contributing

We welcome contributions to this project, and are grateful for your interest. Contributions can take many forms, including bug reports, feature requests code contributions and documentation.

Reporting Bugs and Issues

Errors in the library should be added to the GitHub issue tracker.

Feature Requests

We're always open to suggestions for new features, please check the GitHub issue tracker to see if your concern has been discussed. If not, please open a new issue with the 'enhancement' label.

Submitting Code or Documentation Changes

Your pull request should include a description of changes, any relevant issue numbers, and tests to cover the proposed changes.

Questions and Discussion

Questions about the library and its use can be asked on the Bempp Discourse.

Licence

KiFMM is licensed under a BSD 3-Clause licence. Full text of the licence can be found here.