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
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-deps
The functionality of the library can be tested by running:
cargo test
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.