wlsong/PyLipID: PyLipID - A Python Package For Lipid Interactions Analysis

==========================================================
PyLipID - A Python Package For Lipid Interactions Analysis
==========================================================

PyLipID is a python package for analyzing lipid interactions with membrane proteins from
Molecular Dynamics Simulations. PyLipID has the following main features, please check out
the tutorials for examples and the documentations for the API functionalities:

    * Detection of binding sites via calculating community structures in the interactions networks.
    * Calculation of lipid koff and residence time for interaction with binding sites and residues.
    * Analysis of lipid interactions with binding sites and residues using a couple of metrics.
    * Generation of representative bound poses for binding sites.
    * Analysis of bound poses for binding sites via automated clustering scheme.
    * Adoption of a dual-cutoff scheme to overcome the 'rattling in cage' effect of coarse-grained simulations.
    * Generation of manuscript-ready figures for analysis.

PyLipID can be used from Jupyter (former IPython, recommended), or by writing Python scripts.
The documentaion and tutorials can be found at `pylipid.readthedocs.io <https://pylipid.readthedocs.io>`_.

Installation
============

We recommend installing PyLipID using the package installer `pip`:

``pip install pylipid``

Alternatively, PyLipID can be installed from the source code. The package is available for
download on Github via:

``git clone https://github.com/wlsong/PyLipID``

Once the source code is downloaded, enter the source code directory and install the package as follow:

``python setup.py install``