Skip to main content

Calculate NMR relaxation time from molecular dynamics trajectory file

Project description

https://readthedocs.org/projects/nmrformd/badge/?version=latest https://raw.githubusercontent.com/simongravelle/nmrformd/main/docs/source/images/NMRforMD_READMEc.png

NMRforMD is a python toolkit to calculate NMR relaxation times from molecular dynamics trajectory files. Used in combination with MDAnalysis, it allows for the analysis of trajectory files from LAMMPS and GROMACS simulation package.

Notes :
  • NMRforMD is still in development, please raise an issue on Github if you encounter a problem

  • the code has mostly been tested with GROMACS and LAMMPS trajectory files, but should work with other molecular dynamics packages, as long as they are compatible with MDAnalysis

  • NMRforMD does not work with triclinic box, use MDAnalysis to convert your trajectory to orthorhombic

https://raw.githubusercontent.com/simongravelle/nmrformd/main/docs/source/images/main_image.png

Example of systems that can be analysed using NMRforMD, from left to right: a bulk water reservoir, a PEG molecule, and water in a slit silica pore.

For details and instructions for beginners, have a look at the documentation.

Installation

Using pip, type in a terminal:

pip3 install nmrformd

To get the last version, clone this repository on your computer and use pip3 from the main directory:

git clone https://github.com/simongravelle/nmrformd.git

cd nmrformd/

pip install .

You can run the tests using pytest:

cd tests
pytest .

Basic example

This is an example showing how to use NMRforMD to measure NMR signal from a molecular dynamics simulations. See the tutorial for more information.

import MDAnalysis as mda
import nmrformd
u = mda.Universe("topology.tpr", "trajectory.xtc")
nmr_result = nmrformd.NMR(u, "type H", "type H")

The NMR relaxation time T1 is given by nmr_result.T1.

Known issues

  • for very large trajectory file, the code requires a lot of memory

  • the code has only beed tested with hydrogen atoms

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

nmrformd-0.1.0.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

nmrformd-0.1.0-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file nmrformd-0.1.0.tar.gz.

File metadata

  • Download URL: nmrformd-0.1.0.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.10

File hashes

Hashes for nmrformd-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7510d29f1b4254a5cd53b2616a98799b3c1eb76fbb9f2a861db4379f390989a6
MD5 1b3c78b715af1977149fe729ffd7dc81
BLAKE2b-256 9f561e641ff611328507b952aa4a8dd83862504217b19db4f45336630ac05434

See more details on using hashes here.

File details

Details for the file nmrformd-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: nmrformd-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.10

File hashes

Hashes for nmrformd-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 85e21b5db3ab55c566f8fad73bb1288463d6348ad1bb5501f343a2ab3ef31a24
MD5 df7b018352d9660704bdf508546c8688
BLAKE2b-256 74a7a3d55b6e9d5040412ef496ad85b6c2a0e1bc08ba04cf76b773f22a72ea11

See more details on using hashes here.

Supported by

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