Dimensionality reduction method for MD trajectories
Project description
Unrolr
Conformational analysis of MD trajectories based on (pivot-based) Stochastic Proximity Embedding using dihedral distance as a metric (https://github.com/jeeberhardt/unrolr).
Prerequisites
You need, at a minimum (requirements.txt):
- Python 2.7 or python 3
- NumPy
- H5py
- Pandas
- Matplotlib
- PyOpenCL
- MDAnalysis (>=0.17)
Installation on UNIX (Debian/Ubuntu)
I highly recommand you to install the Anaconda distribution (https://www.continuum.io/downloads) if you want a clean python environnment with nearly all the prerequisites already installed (NumPy, H5py, Pandas, Matplotlib).
1 . First, you have to install OpenCL:
- MacOS: Good news, you don't have to install OpenCL, it works out-of-the-box. (Update: bad news, OpenCL is now depreciated in macOS 10.14. Thanks Apple.)
- AMD: You have to install the AMDGPU graphics stack.
- Nvidia: You have to install the CUDA toolkit.
- Intel: And of course it's working also on CPU just by installing this runtime software package. Alternatively, the CPU-based OpenCL driver can be also installed through the package
pocl
(http://portablecl.org/) with the conda package manager.
For any other informations, the official installation guide of PyOpenCL is available here.
2 . As a final step, installation from PyPi server
pip install unrolr
Or from the source
# Get the package
wget https://github.com/jeeberhardt/unrolr/archive/master.zip
unzip unrolr-master.zip
rm unrolr-master.zip
cd unrolr-master
# Install the package
python setup.py install
And if somehow pip is having problem to install all the dependencies,
conda config --append channels conda-forge
conda install pyopencl mdanalysis
# Try again
python setup.py install
OpenCL context
Before running Unrolr, you need to define the OpenCL context. And it is a good way to see if everything is working correctly.
python -c 'import pyopencl as cl; cl.create_some_context()'
Here in my example, I have the choice between 3 differents computing device (2 graphic cards and one CPU).
Choose platform:
[0] <pyopencl.Platform 'AMD Accelerated Parallel Processing' at 0x7f97e96a8430>
Choice [0]:0
Choose device(s):
[0] <pyopencl.Device 'Tahiti' on 'AMD Accelerated Parallel Processing' at 0x1e18a30>
[1] <pyopencl.Device 'Tahiti' on 'AMD Accelerated Parallel Processing' at 0x254a110>
[2] <pyopencl.Device 'Intel(R) Core(TM) i7-3820 CPU @ 3.60GHz' on 'AMD Accelerated Parallel Processing' at 0x21d0300>
Choice, comma-separated [0]:1
Set the environment variable PYOPENCL_CTX='0:1' to avoid being asked again.
Now you can set the environment variable.
export PYOPENCL_CTX='0:1'
Example
from __future__ import print_function
from unrolr import Unrolr
from unrolr.feature_extraction import Dihedral
from unrolr.utils import save_dataset
top_file = 'examples/inputs/villin.psf'
trj_file = 'examples/inputs/villin.dcd'
# Extract all calpha dihedral angles from trajectory and store them into a HDF5 file (start/stop/step are optionals)
d = Dihedral(top_file, trj_file, selection='all', dihedral_type='calpha', start=0, stop=None, step=1).run()
X = d.result
save_dataset('dihedral_angles.h5', "dihedral_angles", X)
# Fit X using Unrolr (pSPE + dihedral distance) and save the embedding into a csv file
U = Unrolr(r_neighbor=0.27, n_iter=50000, verbose=1)
U.fit(X)
U.save(fname='embedding.csv')
print('%4.2f %4.2f' % (U.stress, U.correlation))
Todo list
- Compare SPE performance with UMAP
- Compatibility with python 3
- Compatibility with the latest version of MDAnalysis (==0.17)
- Unit tests
- Accessible directly from pip
- Improve OpenCL performance (global/local memory)
Citation
Eberhardt, J., Stote, R. H., & Dejaegere, A. (2018). Unrolr: Structural analysis of protein conformations using stochastic proximity embedding. Journal of Computational Chemistry, 39(30), 2551-2557. https://doi.org/10.1002/jcc.25599
License
MIT
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
Built Distribution
Hashes for unrolr-0.4.0.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 920ff8de027ac7f07a936e93e9f1354e5fc4682e27ed81e66c037363605ee343 |
|
MD5 | b753306d4cea65de5bd2285f9de25e52 |
|
BLAKE2b-256 | defc1904b0b4db100929bb7dda55a1dff7ce446d9cb8437c495ad5c2086757d5 |