Skip to main content

A macromolecular docking framework

Project description

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

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

Integrative Modeling of Membrane-associated Protein Assemblies
Jorge Roel-Touris, Brian Jiménez-García & Alexandre M.J.J. Bonvin
Nat Commun 11, 6210 (2020); doi: https://doi.org/10.1038/s41467-020-20076-5

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+.
  • 100% compatible with Google Colab platform

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.2. Install LightDock

The fastest way to install LightDock is to use pip:

pip 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
  • prody>=1.10.11
  • freesasa>=2.0.3

It is recommended to create a virtual environment and install it:

virtualenv venv
source venv/bin/activate
cd lightdock
pip install -e .

If not using pip or setuptools for development, 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

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 was already reported
  2. Open a new issue in this repository
  3. Or write an email to lightdocking@gmail.com (we will do our best to answer your questions as soon as possible)

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.2.tar.gz (36.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lightdock-0.9.2-cp38-cp38-macosx_10_15_x86_64.whl (38.0 MB view details)

Uploaded CPython 3.8macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: lightdock-0.9.2.tar.gz
  • Upload date:
  • Size: 36.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.8

File hashes

Hashes for lightdock-0.9.2.tar.gz
Algorithm Hash digest
SHA256 74367f129d7c5fa221d69753fecc655393fb138e0f60c2e836c4dabdf31fbc09
MD5 2b73236513371b25be8b62e5eb7a68df
BLAKE2b-256 a8a0979fded80359f68ff5e6d4ce6a4b79c8d99f9cb90d11a6ba56e915b38216

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lightdock-0.9.2-cp38-cp38-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 38.0 MB
  • Tags: CPython 3.8, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.8

File hashes

Hashes for lightdock-0.9.2-cp38-cp38-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 28db53162f60a5c6faa5704050b752b2d369d392c638e5ff025e5081daded571
MD5 6345ef862b966fdd8a0ce3a0f6cd7677
BLAKE2b-256 01fd813cd59b40b864750ad7b80da9cc4f21fd72a2f9021f63a2d9d7e3863c3d

See more details on using hashes here.

Supported by

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