Open source SASA calculations
|View on GitHub|
![DOI](https://zenodo.org/badge/18467/mittinatten/freesasa.svg) ![Build Status](https://travis-ci.org/mittinatten/freesasa.svg?branch=master) ![Coverage Status](https://coveralls.io/repos/github/mittinatten/freesasa/badge.svg?branch=master)
C-library for calculating Solvent Accessible Surface Areas.
License: MIT (see file LICENSE). Copyright: Simon Mitternacht 2013-2016.
FreeSASA is a C library and command line tool for calculating Solvent Accessible Surface Area (SASA) of biomolecules. It is designed to be simple to use with defaults, but allows customization of all parameters of the calculation and provides a few different tools to analyze the results. Python bindings are also included in the repository.
By default Lee & Richards' algorithm is used, but Shrake & Rupley's is also available. Both can be parameterized to arbitrary precision, and for high resolution versions of the algorithms, the calculations give identical results.
FreeSASA assigns a radius and a class to each atom. The atomic radii are by default the ProtOr radii defined by Tsai et al. (JMB 1999, 290: 253) for standard amino acids and nucleic acids, and the van der Waals radius of the element for other atoms. Each atom is also classified as either polar or apolar.
Users can provide their own atomic radii and classifications via configuration files. The input format for configuration files is described in the online documentation, and the
share/ directory contains some sample configurations, including one for the NACCESS parameters (Hubbard & Thornton 1993).
Version 2.0 adds some new features and breaks a few parts of the interface from 1.x (mainly the API), see CHANGELOG.md for detailed information.
FreeSASA can be compiled and installed using the following
./configure make && make install
NB: If the source is downloaded from the git repository the configure-script needs to be set up first using
autoreconf -i. Users who don't have autotools installed, can download a tarball that includes the autogenerated scripts from http://freesasa.github.io/ or from the latest GitHub-release.
The above commands build and install the command line tool
freesasa (built in
src/), the command
gives an overview of options. To run a calculation from PDB-file input using the defaults, simply type
make install installs the header
freesasa.h and the library
libfreesasa. If the configure script is called with the option
--enable-python-bindings, the Python module is also built and installed.
The configuration can be changed with these options:
--enable-python-bindingsbuilds Python bindings, requires Cython 0.21 or higher. On some platforms the C library needs to be compiled with
CFLAGS=-fPICto allow it to be linked to the Python module.
--with-python=<python>specifies which python binary to use
--disable-jsonbuild without support for JSON output.
--disable-xmlbuild without support for XML output.
--disable-threadsbuild without multithreaded calculations
--enable-doxygenactivates building of Doxygen documentation
--enable-checkenables unit-testing using the Check framework
--enable-gcovadds compiler flags for measuring coverage of tests using gcov
--enable-parser-generatorrebuild parser/lexer source from Flex/Bison sources (the autogenerated code is included in the repository, so no need to do this if you are not going to change the parser).
After building the package, calling
explains how the commandline tool can be used.
The program has been tested successfully with several versions of GNU C Compiler and Clang/LLVM. The library can be built using only standard C and GNU libraries. The standard build depends on json-c and libxml2. These can be disabled by configuring with
Developers who want to do testing need to install the Check unit testing framework. Building the full reference manual requires Doxygen (version > 1.8.8). Building the Python bindings requires Cython. Changing the selection parser and lexer requires Flex and Bison. These build options, which add extra dependencies, are disabled by default to simplify installation for users only interested in the command line tool and and/or C Library.
FreeSASA can be cited using the following publication
The DOI numbers from Zenodo can be used to cite a specific version of FreeSASA.