Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

A macromolecular docking framework

Project description

License: GPL v3 PyPi version PyPi Downloads Supported versions Build Status Code Coverage Commit activity

1. Synopsis

LightDock is a protein-protein, protein-peptide and protein-DNA docking framework based on the Glowworm Swarm Optimization (GSO) algorithm.

The LightDock framework is highly versatile, with many options that can be further developed and optimized by the users: it can accept any user-defined scoring function, can use local gradient-free minimization, the simulation can be restrained from the beginning to focus on user-assigned interacting regions, it supports residue restraints in both receptor and ligand partners.

2. Reference

LightDock protocol and the updates to make use of residue restraints have been published in Oxford Bioinformatics journal. Please cite these references if you use LightDock in your research:

LightDock: a new multi-scale approach to protein–protein docking Brian Jiménez-García, Jorge Roel-Touris, Miguel Romero-Durana, Miquel Vidal, Daniel Jiménez-González and Juan Fernández-Recio Bioinformatics, Volume 34, Issue 1, 1 January 2018, Pages 49–55, https://doi.org/10.1093/bioinformatics/btx555

LightDock goes information-driven Jorge Roel-Touris, Alexandre M.J.J. Bonvin, Brian Jiménez-García Bioinformatics, btz642; doi: https://doi.org/10.1093/bioinformatics/btz642

3. Installation

Lightdock software is compatible and it has been tested with the followings OS:

  • macOS: El Capitan, Sierra, High Sierra, Mojave, Catalina.
  • GNU/Linux: Ubuntu 16+, Debian Stretch+, Scientific Linux 6+, CentOS 6+.

Microsoft Windows is not officially supported, despite many parts of the protocol might be able to run. Please use it at your own risk. If you wish to contribute testing and developing LightDock for Windows, please contact us.

3.1. Dependencies

LightDock has the following dependencies:

Optional dependencies are:

3.1.1. Installing NumPy, Scipy, Cython, Biopython and ProDy

pip3 install numpy, scipy, cython, biopython, pyparsing, prody

3.2. Install LightDock

The fastest way to install LightDock is to use pip:

pip3 install lightdock

4. Development

For development and extension of the LightDock code, please follow these instructions:

4.1. Clone

Clone this repository:

git clone https://github.com/lightdock/lightdock.git

4.2. Compile Python C and Cython extensions

Please make sure dependencies are already installed (via pip, package manager, etc.):

  • numpy>=1.17.1
  • scipy>=1.3.1
  • cython>=0.29.13
  • biopython>=1.74
  • pyparsing>=2.4.2
  • prody>=1.10.11
  • freesasa>=2.0.3

There is as bash script to compile all the extensions:

cd lightdock
./setup.sh

4.3. Add Lightdock to your path

Add the following lines to your ~/.bashrc file, don't forget to change /path/to/lightdock:

# LightDock
export LIGHTDOCK_HOME="/path/to/lightdock"
export PATH=$PATH:$LIGHTDOCK_HOME/bin
export PYTHONPATH=$PYTHONPATH:$LIGHTDOCK_HOME

Don't forget to apply the changes:

source ~/.bashrc

4.4. Testing

You can run LightDock tests:

cd lightdock
nosetests-3.8 

5. Documentation

The complete documentation about how to run the LightDock protocol and several tutorials and use cases can be found at https://lightdock.org/tutorials.

6. Get Help

LightDock is being actively developed and some issues may arise or you may need extra help to run LightDock. In those cases, there are two main ways to get help:

  1. Read the FAQ in case your problem is known
  2. Open a new issue in this repository
  3. Or write an email to b.jimenezgarcia@uu.nl

7. LICENSE

LightDock is available under GPLv3 License. See LICENSE document for more details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for lightdock, version 0.8.1
Filename, size File type Python version Upload date Hashes
Filename, size lightdock-0.8.1-cp38-cp38-macosx_10_15_x86_64.whl (34.1 MB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size lightdock-0.8.1.tar.gz (33.0 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page