Skip to main content

Calculate NMR relaxation time from molecular dynamics trajectory file

Project description

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.

Information

This documentation is separated in four parts: tutorials, how-to scripts, description, and theory.

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

Notes :
  • NMRforMD is still in development, please raise an issue here 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

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

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.0.9.tar.gz (7.7 kB view hashes)

Uploaded Source

Built Distributions

nmrformd-0.0.9-py3-none-any.whl (20.1 kB view hashes)

Uploaded Python 3

nmrformd-0.0.9-py2.py3-none-any.whl (20.1 kB view hashes)

Uploaded Python 2 Python 3

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