Skip to main content

Tools for molecular dynamics simulation setup and analysis.

Project description

MDPlus: Python tools for molecular modelling.

Introduction

MDPlus brings together a number of tools related to the setup and analysis of molecular simulations:

  • PCA - the Principal Component Analysis library as used by pyPcazip.

  • Glimps - a machine learning method for backmapping coarse-grained structures to finer-grained ones.

  • ENM - an elastic network approach to the refinement of approximate molecular models.


Installation:

Easiest via pip:

pip install mdplus

Getting started:

API overview

For maximum compatibility with other Python-based MD simulation processing packages, All tools operate on simple arrays of coordinate data (typically [n_frames, n_atoms, 3] numpy arrays).

All tools have a similar API, modelled on the transformer object approach that used by many of the utilities in scipy and scikit-learn.

PCA

An instance of a PCA transformer is fit to an ensemble of structures, to obtain the eigenvectors, eigenvalues and mean. This trained transformer can then be used to transform further coordinate sets of the same system into the PCA space, and vice-versa:

from mdplus.pca import PCA

pca_transformer = PCA()
pca_transformer.fit(traj) # traj should be an [n_frames, n_atoms, 3] numpy array
scores = pca_transformer.transform(traj) # scores will be an [n_frames, n_components] numpy array
reconstituted_traj = pca_transformer.inverse_transform(scores)

Glimps

While tools to transform high-resolution models to lower resolution ones (e.g. atomistic to coarse-grained) are relatively available and/or easy to implement, the reverse - "back-mapping" - is typically much harder. Given a training set of high-resolution structures and their low-resolution counterparts obtained by application of a forward-mapping tool, Glimps learns the reverse transform from the low resolution dataset to the higher resolution one, and once trained can back-map further low-resolution models.

from mdplus.multiscale import Glimps

backmapper = Glimps()
backmapper.fit(cg_training_traj, fg_training_traj) # matched pairs of low and high resolution structures
fg_structure = backmapper.transform(cg_structure)

Command-line tools for back mapping are also available - see the glimps_example folder.

ENM

ENM implements an elastic network restraints-based refinement of approximate molecular structures. It can be a useful post-processor for structures obtained from PCA inverse transforms or from Glimps. ENM learns the set of restraints from a training set of "good" molecular structures, and can then refine further approximate structures:

from mdplus.refinement import ENM

refiner = ENM()
refiner.fit(training_traj) # A diverse collection of good-quality structures
refined_traj = refiner.transform(crude_traj)

Who do I talk to?

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

mdplus-0.1.0.tar.gz (169.8 kB view details)

Uploaded Source

Built Distribution

mdplus-0.1.0-cp39-cp39-manylinux1_x86_64.whl (842.6 kB view details)

Uploaded CPython 3.9

File details

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

File metadata

  • Download URL: mdplus-0.1.0.tar.gz
  • Upload date:
  • Size: 169.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.10

File hashes

Hashes for mdplus-0.1.0.tar.gz
Algorithm Hash digest
SHA256 46abd13b02da786495fa8249ac7e08aac1893a4f74e4921be1b750c552b9d2da
MD5 eaab4fdfc8664c843f4b2f1767e8484f
BLAKE2b-256 babc4d3c25efaeb5f06fb23024a6fd6d91eb5add2317435d8bd823595d17eb9c

See more details on using hashes here.

File details

Details for the file mdplus-0.1.0-cp39-cp39-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for mdplus-0.1.0-cp39-cp39-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 fa8f706a25e59efcaa286a615602a634fafc675c98ff3cab10097032ef80a770
MD5 7c7ead77a199c615cab7de5ea09904b4
BLAKE2b-256 f499d0551e245f6979e3c3eb425be24a0b4d8edee74fa765ade42adf7c417420

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