Skip to content

A Python script to plot dynamical correlations for proteins.

License

LGPL-3.0, GPL-3.0 licenses found

Licenses found

LGPL-3.0
COPYING.LESSER
GPL-3.0
COPYING
Notifications You must be signed in to change notification settings

bneron/correlationplus

 
 

Repository files navigation

PyPI - Python Version PyPI Open Source License: GPL v3 Doc Docker Image Version (tag latest semver) Conda SWH

correlationplus

A Python package to calculate, visualize and analyze correlation maps of proteins.

correlationplus contains four main scripts that you can use to calculate, visualize and analyze correlation maps of proteins. These correlations can be dynamical cross-correlations, linear mutual information, sequence based covariation/coevolution or any other pairwise coupling metric. You can use elastic network models or your molecular dynamics trajectories for calculation of dynamical correlations.

Video Tutorials

Installation

We recommend one of the installation methods for regular users:

with conda

conda install -c bioconda correlationplus

with pip

The pip version required by some dependencies is >= 21.0.1, which is not the pip version bundle with python 3.(6,7,8) So, you have to update pip before installing correlationplus. Otherwise, you will have trouble during MDAnalysis dependency installation. For this reason, we strongly encourage you to install correlationplus in a virtualenv.

python3 -m venv correlationplus
cd correlationplus
source bin/activate
python3 -m pip install -U pip
python3 -m pip install correlationplus

if you want to install it without using a virtualenv and encounter an error related to llvmlite, you can solve it as follows:

python3 -m pip install llvmlite --ignore-installed
python3 -m pip install correlationplus

or if you do not have administration rights

python3 -m pip install --user llvmlite --ignore-installed
python3 -m pip install --user correlationplus

Most of the time, at least one these methods will be sufficient for the installation. However, if these two methods didn't work for any reason, you can take a look to 'Advanced Installation' instructions at https://correlationplus.readthedocs.io/en/latest/installation.html#advanced-installation.

Quickstart

There are four main scrips:

  • calculate
  • visualize
  • analyze
  • paths

You can find details of each script with the following commands:

correlationplus calculate -h
correlationplus visualize -h
correlationplus analyze -h
correlationplus paths -h

Go to our readthedocs for detailed usage examples for each script.

Licensing

correlationplus is developed and released under GNU Lesser GPL Licence. Please read to the COPYING and COPYING.LESSER files to know more.

About

A Python script to plot dynamical correlations for proteins.

Resources

License

LGPL-3.0, GPL-3.0 licenses found

Licenses found

LGPL-3.0
COPYING.LESSER
GPL-3.0
COPYING

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 98.5%
  • Dockerfile 1.2%
  • Roff 0.3%