Skip to main content

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.

Project details


Download files

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

Source Distribution

lightdock-0.9.0.tar.gz (35.9 MB view details)

Uploaded Source

Built Distribution

lightdock-0.9.0-cp38-cp38-macosx_10_15_x86_64.whl (37.5 MB view details)

Uploaded CPython 3.8macOS 10.15+ x86-64

File details

Details for the file lightdock-0.9.0.tar.gz.

File metadata

  • Download URL: lightdock-0.9.0.tar.gz
  • Upload date:
  • Size: 35.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/54.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.8

File hashes

Hashes for lightdock-0.9.0.tar.gz
Algorithm Hash digest
SHA256 7e79a9a0113fc569327756d116c4237ed3663a4da6723180adcf3af7b0fcfdae
MD5 c8fa66123ef18e4483979860603e80c3
BLAKE2b-256 125c98dcd25e4a40008579b8f3ab1f62d89b3e0e6a27b784eacd1438681cfa9a

See more details on using hashes here.

File details

Details for the file lightdock-0.9.0-cp38-cp38-macosx_10_15_x86_64.whl.

File metadata

  • Download URL: lightdock-0.9.0-cp38-cp38-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 37.5 MB
  • Tags: CPython 3.8, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/54.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.8

File hashes

Hashes for lightdock-0.9.0-cp38-cp38-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 287c3bc00c560a928ad645fca4bfc85beea8cae0e0ac2ff587fa8ed84c82aadc
MD5 07f0af513d67f475265e26f8bf3d7e32
BLAKE2b-256 f6b3cd98a9b82f40b9ba67a9ef8e47da041d8fc396463d6a231ecbe68884d72e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page