1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
|
FreeSASA Python module
======================
[](https://ci.appveyor.com/project/mittinatten/freesasa-python/branch/master)
[](https://travis-ci.org/freesasa/freesasa-python)
The module provides Python bindings for the [FreeSASA C Library](https://github.com/mittinatten/freesasa).
There are PyPi packages for Python 3.6+, on Linux, Mac OS X and Windows.
And it can be built from source for 2.7+ (Or by downloading older PyPi packages).
Documentation can be found at http://freesasa.github.io/python/.
Install the module by
~~~~sh
pip install freesasa
~~~~
Developers can clone the library, and then build the module by the following
~~~~sh
git submodule update --init
USE_CYTHON=1 python setup.py build
~~~~
Tests can be run using
~~~~sh
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.
|