Skip to main content

A package for DEER and PRE predictions based on molecular dynamics ensembles. Can be installed with pip.

Project description

Build Status Documentation Status DOI SWH

DEER-PREdict

Overview

A package for double electron-electron resonance (DEER) and paramagnetic relaxation enhancement (PRE) predictions from molecular dynamics ensembles.

Installation

To install DEER-PREdict, use the PyPI package:

  pip install DEERPREdict

or clone the repo:

  git clone https://github.com/KULL-Centre/DEERpredict.git
  cd DEERpredict

  pip install -e . 

The software requires Python 3.6-3.9.

In case of dependency issues, consider installing FRETpredict in a new environment

  conda create -n myenv python=3.9 pip
  conda activate myenv
  pip install -e .

Documentation

Documentation Status

Testing

Run all the tests in one go

  cd DEERpredict

  python -m pytest

or run single tests, e.g.

  cd DEERpredict

  python -m pytest tests/test_PRE.py::test_ACBP
  python -m pytest tests/test_DEER.py::test_T4L

Example

Example of how to run PREpredict to calculate the intensity ratios and PRE rates for PDB code 1NTI (20 conformations) using the BASL MMMx rotamer library (see notebook)

PRE = PREpredict(MDAnalysis.Universe('1nti.pdb'), residue=36, libname='BASL MMMx',
          tau_t=.5*1e-9, log_file='calcPREs/log', temperature=298, z_cutoff=0.05,
          atom_selection='H', Cbeta=False)
PRE.run(output_prefix='calcPREs/BASL', tau_t=.5e-9, delay=10e-3,
          tau_c=2e-09, r_2=10, wh=750)

License

This project is licensed under the GNU General Public License version 3.0 (GPL-3.0). However, the rotamer libraries are modified versions of those from the MMMx program, and these modified libraries are licensed under the MIT License, as detailed in the LICENSE file. The rest of the project is licensed under the GPL-3.0, and any combination of GPL-3.0 licensed files with those under the MIT License will be subject to the terms of the GPL-3.0.

Authors

Giulio Tesei (@gitesei)

João M Martins (@joaommartins)

Micha BA Kunze (@mbakunze)

Ramon Crehuet (@rcrehuet)

Kresten Lindorff-Larsen (@lindorff-larsen)

Article

Tesei G, Martins JM, Kunze MBA, Wang Y, Crehuet R, and Lindorff-Larsen K (2021) DEER-PREdict: Software for efficient calculation of spin-labeling EPR and NMR data from conformational ensembles. PLOS Computational Biology 17(1): e1008551. https://doi.org/10.1371/journal.pcbi.1008551

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

DEERPREdict-0.2.2.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

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

DEERPREdict-0.2.2-py2.py3-none-any.whl (1.4 MB view details)

Uploaded Python 2Python 3

File details

Details for the file DEERPREdict-0.2.2.tar.gz.

File metadata

  • Download URL: DEERPREdict-0.2.2.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/6.0.0 pkginfo/1.9.6 requests/2.29.0 requests-toolbelt/0.9.1 tqdm/4.65.0 CPython/3.8.16

File hashes

Hashes for DEERPREdict-0.2.2.tar.gz
Algorithm Hash digest
SHA256 b60efc60995d68c19cb6ea328df7eabc36fbd67ae780a9f08c562498b3eb48ab
MD5 1d69a6d06a6bbcf515cbba516549ac82
BLAKE2b-256 a1cb80163265ac0402766921dbec3db6db8f5941ff391e813dac8dd89f082aaa

See more details on using hashes here.

File details

Details for the file DEERPREdict-0.2.2-py2.py3-none-any.whl.

File metadata

  • Download URL: DEERPREdict-0.2.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/6.0.0 pkginfo/1.9.6 requests/2.29.0 requests-toolbelt/0.9.1 tqdm/4.65.0 CPython/3.8.16

File hashes

Hashes for DEERPREdict-0.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0903f1119a3e8248de27ca8e1b0da7c63033c7fbd3fe90d99b88daf9d3384938
MD5 428ff47e314bc4753e0cd2acafe77d17
BLAKE2b-256 d8922831d13324a3bd1c4889c4502d2a448798cb0081fbb4fae13e908fe64c67

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