/freesasa-python

FreeSASA Python Module

Primary LanguagePythonMIT LicenseMIT

FreeSASA Python module

Appveyor build status Travis build status

The module provides Python bindings for the FreeSASA C Library. It works with Python 2.7 and 3.5+, on Linux, Mac OS X and Windows. Documentation can be found at http://freesasa.github.io/python/.

Install the module by

pip install freesasa

Developers can clone the library, and then build the module by the following

git submodule update --init
USE_CYTHON=1 python setup.py build

Tests can be run using

python setup.py test

Adding new features

This Python module provides a limited mapping to the C API of FreeSASA. I wish to extend the module with more functionality out of the box, to match the capabilities of the C API more closely, and perhaps also add more complex analysis that would be cumbersome to write in C. Feel free to submit feature request as GitHub issues. A few simple suggestions are already listed as issues. I only work on FreeSASA in my spare time, so PRs are always welcome.