Skip to content

Commit

Permalink
Redirect Python users to the new module
Browse files Browse the repository at this point in the history
  • Loading branch information
mittinatten committed Feb 28, 2018
1 parent e3aac72 commit ed5df92
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.md
Expand Up @@ -70,17 +70,9 @@ using the defaults, simply type
freesasa <pdb-file>

In addition, `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. Users who are only interested in Python can alternatively use
the repository https://github.com/freesasa/freesasa-python.
library `libfreesasa`.

The configuration can be changed with these options:
* `--enable-python-bindings` builds Python bindings, requires Cython
0.21 or higher. On some platforms the C library needs to be
compiled with `CFLAGS=-fPIC` to allow it to be linked to the
Python module.
* `--with-python=<python>` specifies which python binary to use
* `--disable-json` build without support for JSON output.
* `--disable-xml` build without support for XML output.
* `--disable-threads` build without multithreaded calculations
Expand All @@ -95,6 +87,19 @@ For developers:
repository, so no need to do this if you are not going to change
the parser).

Python module
-------------

The Python bindings are available from PyPi and can be installed using

pip install freesasa

This module is found in a separate repository
https://github.com/freesasa/freesasa-python
(the bindings included here will eventually be removed).
The PyPi module has binaries for Mac OS X and Windows, for a number
of Python versions.

Documentation
-------------

Expand Down

0 comments on commit ed5df92

Please sign in to comment.