We currently only support Unix distributions.
# Clone the repo
# git clone [email protected]:bempp/kifmm.git
# git clone https://github.com/bempp/kifmm.git
# Build in release mode (optional)
cd kifmm && cargo build --release
# Build with MPI support (optional)
cd kifmm && cargo build --release --features mpiThe current release version can be installed using the deployment on crates.io, and can be added to your Cargo.toml file with
cargo add kifmmAlternatively, add as a dependency to your Cargo.toml file from the current head.
# Optionally build with MPI
kifmm = { git = "https://github.com/bempp/kifmm.git", features = ["mpi"] }Though we note that MPI functionality is not supported in the current release version on crates.io, and users must install from source in order to use the MPI variant.
The main external dependencies of this package are
- FFTW
- BLAS
- LAPACK
- MPI (Optional)
FFTW is automatically downloaded, built and linked with optimal settings as a part of the provided Cargo build. For linear algebra and matrix computations we use the RLST crate, which itself detects and compiles with respect to the BLAS and LAPACK installed on your system, this must be exposed to your LD_LIBRARY_PATH. MPI, if used, is also detected from your system MPI and similarly must be exposed to your LD_LIBRARY_PATH.
A quickstart example is available in the kifmm/ directory's README, alongside instructions for building Python bindings or using the C bindings with CMake.
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-depsThe functionality of the shared memory library can be tested with
# Run tests in release mode (optional)
cargo test --releaseThere are also numerous MPI tests and examples in the examples folder. Tests are marked with the mpi_test_* prefix. For these we recommend the cargo mpirun utility library. With this, distributed memory tests can be run with.
# Run tests in release mode (optional)
cargo mpirun -n <num_processes> --example mpi_test_fmm --releaseThis 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 example slurm scripts, and build hints for successfully compiling kifmm-rs on HPC platforms.
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.
Errors in the library should be added to the GitHub issue tracker.
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.
Your pull request should include a description of changes, any relevant issue numbers, and tests to cover the proposed changes.
Questions about the library and its use can be asked on the Bempp Discourse.
KiFMM is licensed under a BSD 3-Clause licence. Full text of the licence can be found here.