Calculate NMR relaxation time from molecular dynamics trajectory file
Project description
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file nmrformd-0.0.9.tar.gz
.
File metadata
- Download URL: nmrformd-0.0.9.tar.gz
- Upload date:
- Size: 7.7 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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e0d38413c984b093ee4e8411550a7f372a4d3e66c0c0f41f664c229e5d9b125 |
|
MD5 | b0ec85cd1fc9fba1a6e2e4aab51e44e7 |
|
BLAKE2b-256 | 68407079a4ae92316df1989df04309fafa91dccbd65b08e511cd58d1682c094a |
File details
Details for the file nmrformd-0.0.9-py3-none-any.whl
.
File metadata
- Download URL: nmrformd-0.0.9-py3-none-any.whl
- Upload date:
- Size: 20.1 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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 260d6d0a97018b47404cdf8c71f4b1ca94557c89ffb48c9ebe0376f738f21538 |
|
MD5 | 8ed1e6e7684287871e1c2065b721bb8f |
|
BLAKE2b-256 | 36f95b7fc6ff69ce7adb976666224a9428653c974468a9584d26d293a569a579 |
File details
Details for the file nmrformd-0.0.9-py2.py3-none-any.whl
.
File metadata
- Download URL: nmrformd-0.0.9-py2.py3-none-any.whl
- Upload date:
- Size: 20.1 kB
- Tags: Python 2, 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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5bf67ea83cbfa679e09959282bc92ecf9a425888e01cf21d0a89cd1c70eb8a1c |
|
MD5 | ad67d6ffcf34a3c8f0dd68c6554ca71c |
|
BLAKE2b-256 | a4ff61358f37287d8ee4b0bc4d085554639a43e2c7bc46de3f43bceffceae0e3 |