FAQ | This is a LIVE service | Changelog

Skip to content
Snippets Groups Projects
README.md 1.15 KiB
Newer Older
O. Wissett's avatar
O. Wissett committed
# FreeSASA FFI

This crate provides raw FFI bindings to the [freesasa](https://freesasa.github.io/doxygen/index.html)
O. Wissett's avatar
O. Wissett committed
C library, developed by [Simon Mitternacht](https://github.com/mittinatten) \[1\]. FreeSASA allows
O. Wissett's avatar
O. Wissett committed
you to calculate the solvent accessible surface area (SASA) of a protein from its atomic
coordinates. The library is written in C, and is available under the MIT license.

The bindings in this crate are automatically generated by `bindgen`. Since this crate provides
raw access to a C-library, it is on the user to ensure that memory safety is maintained.

For most uses it is recommended to use the RustSASA crate (which is currently not publicly available).
RustSASA aims to provide a safe idiomatic way of working with freesasa from within Rust.

Please contact me via email, ow257@cam.ac.uk, if you are interested in access to RustSASA.

O. Wissett's avatar
O. Wissett committed
## Docs
https://ch.uniofcam.dev/sormanni/freesasa_sys

O. Wissett's avatar
O. Wissett committed
## License
O. Wissett's avatar
O. Wissett committed
The MIT license

## References
\[1\] Simon Mitternacht (2016) FreeSASA: An open source C library for solvent accessible
surface area calculations. F1000Research 5:189.
O. Wissett's avatar
O. Wissett committed
(doi: [10.12688/f1000research.7931.1](https://f1000research.com/articles/5-189))