Python package to load and analyze MD-simulations from Gromacs.
Go to file
2023-11-10 15:19:44 +01:00
doc Initial version 2022-04-20 14:08:38 +02:00
examples Initial version 2022-04-20 14:08:38 +02:00
src/mdevaluate Removed cached from open 2023-11-10 15:19:44 +01:00
test Initial version 2022-04-20 14:08:38 +02:00
.gitignore Added test trajectory offset files to .gitignore 2023-11-06 11:48:57 +01:00
LICENSE Changed LICENSE 2023-06-30 14:28:37 +02:00
pyproject.toml Moved functions from mdeval_skloth and removed deprecated code 2023-11-05 15:06:28 +01:00
README.md Initial version 2022-04-20 14:08:38 +02:00
requirements.txt Changed requirements 2023-07-03 13:23:15 +02:00

mdevaluate

Mdevaluate is a Python package to perform analyses of Molecular Dynamics simulations. An online documentation is available at mdevaluate.github.io. Mdevaluate provides a flexible interface for the detailed analysis of dynamical and statical properties of molecular systems. It's main focus is the analysis of Gromacs data, but with the help of external packages (MDAnalysis) it can also handle file formats, used by other simulation software.

import mdevaluate as md

# load the simulation
tr = md.open(
	directory='/path/to/simulation',
	topology='topol.tpr',
	trajectory='traj.xtc'
)
# select a subset of atoms
water_oxygen = tr.subset(residue_name='SOL', atom_name='OW')

# calculate the mean squared displacement for this subset
time, msd = md.correlation.shifted_correlation(
	md.correlation.msd, water_oxygen, average=True
)

Installation

The package requires the Python package pygmx, which handles reading of Gromacs file formats. Installation of pygmx is described in its own repository.

The mdevaluate package itself is plain Python code and, hence, can be imported from its directory directly, or may be installed via setuptools to the local Python environment by running

python setup.py install

Running the tests

Mdevaluate includes a test suite that can be used to check if the installation was succesful. It is based on py.test and located in the test directory of this repository. Make sure py.test is installed and run py.test within the repository to check if all tests pass.