Skip to main content

a flexible n-ary clustering package for all applications.

Project description

MDANCE (Molecular Dynamics Analysis with N-ary Clustering Ensembles) is a flexible n-ary clustering package that provides a set of tools for clustering Molecular Dynamics trajectories. The package is written in Python and an extension of the n-ary similarity framework. The package is designed to be modular and extensible, allowing for the addition of new clustering algorithms and similarity metrics.Research contained in this package was supported by the National Institute of General Medical Sciences of the National Institutes of Health under award number R35GM150620.

Menu

Installation

Installation

$ pip install mdance

To check for proper installation, run the following command:

>>> import mdance
>>> mdance.__version__

Background

Molecular Dynamics (MD) simulations are a powerful tool for studying the dynamics of biomolecules. However, the analysis of MD trajectories is challenging due to the large amount of data generated. Clustering is an unsupervised machine learning approach to group similar frames into clusters. The clustering results can be used to reveal the structure of the data, identify the most representative structures, and to study the dynamics of the system.

Clustering Algorithms

NANI

🪄NANI🪄the first installment of MDANCE

k-Means N-Ary Natural Initiation (NANI) is an algorithm for selecting initial centroids for k-Means clustering. NANI is an extension of the k-Means++ algorithm. NANI stratifies the data to high density region and perform diversity selection on top of the it to select the initial centroids. This is a deterministic algorithm that will always select the same initial centroids for the same dataset and improve on k-means++ by reducing the number of iterations required to converge and improve the clustering quality.

Example Usage:

>>> from mdance.cluster.nani import KmeansNANI
>>> data = np.load('data.npy')
>>> N = 4
>>> mod = KmeansNANI(data, n_clusters=N, metric='MSD', N_atoms=1)
>>> initiators = mod.initiate_kmeans()
>>> initiators = initiators[:N]
>>> kmeans = KMeans(N, init=initiators, n_init=1, random_state=None)
>>> kmeans.fit(data)
Open In Colab

A tutorial is available for NANI here.

For more information on the NANI algorithm, please refer to the NANI paper.

eQual

eQual is a O*(N)* clustering algorithm that use the radial threshold to grow the cluster to maximize similarity between members in a cluster. It is an extension of the Radial Threshold Clustering algorithm (Daura and Oscar Conchillo-Solé). eQual has improved with new seed selection methods and tie-breaking criteria.

A tutorial is available for eQual here.

For more information on the eQual algorithm, please refer to the eQual paper.

Clustering Postprocessing

PRIME

🪄 Predict Protein Structure with Precision 🪄

Protein Retrieval via Integrative Molecular Ensembles (PRIME) is a novel algorithm that predicts the native structure of a protein from simulation or clustering data. These methods perfectly mapped all the structural motifs in the studied systems and required unprecedented linear scaling.

2k2e
Fig 1. Superposition of the most representative structures found with extended indices (yellow) and experimental native structures (blue) of 2k2e.

A tutorial is available for PRIME here.

For more information on the PRIME algorithm, please refer to the PRIME paper.

Collab or Contribute?!

Please! Don't hesitate to reach out!

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

mdance-0.3.4.tar.gz (33.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

MDANCE-0.3.4-py3-none-any.whl (31.1 MB view details)

Uploaded Python 3

File details

Details for the file mdance-0.3.4.tar.gz.

File metadata

  • Download URL: mdance-0.3.4.tar.gz
  • Upload date:
  • Size: 33.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.11

File hashes

Hashes for mdance-0.3.4.tar.gz
Algorithm Hash digest
SHA256 4bd891dabeb196e9bf0bcc2d2fae4ebb3b45a4d9061634d71f53c1988768f8ae
MD5 a04df73066f836a2c85b220ff5b3542b
BLAKE2b-256 b27a1e6b2cf02ec53bea6770794d2618e86df20421daa93326b93ce2575728cf

See more details on using hashes here.

File details

Details for the file MDANCE-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: MDANCE-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 31.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.11

File hashes

Hashes for MDANCE-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c5f593ce0be5c4f46fdc168b635b37708fe38f655f0c030316c4a7d3e2dff9ee
MD5 91f8c4ee4a9885209504a1d8753aaf98
BLAKE2b-256 77fdf579b847f0b371b01d0991c3d5892933a86b06c6c43bb6aed9e99a1aa89e

See more details on using hashes here.

Supported by

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