Skip to content

Commit f595ea5

Browse files
authored
MDAKit registration: DomHMM (#164)
* MDAKit registration: DomHMM from https://github.com/BioMemPhys-FAU/domhmm * update later: PyPi install
1 parent 8a04d6a commit f595ea5

File tree

1 file changed

+98
-0
lines changed

1 file changed

+98
-0
lines changed

mdakits/domhmm/metadata.yaml

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# DomHMM - Detect, Analyze, Understand
2+
# --------------------
3+
# TL;DR: DomHMM provides an automated workflow to identify liquid-ordered (Lo) domains from Molecular Dynamics simulations of bio-membranes. :-)
4+
#
5+
# Nano- and microdomains in lipid membranes are of great interest for understanding biological processes such as small molecule binding and signal transduction.
6+
# Molecular Dynamics (MD) present a powerful tool for studying membranes with various lipid compositions at different levels of resolution.
7+
# However, detecting these domains can be challenging, as most workflows are described in papers without available or maintained implementations.
8+
# The MDAKit "DomHMM" faciliates the analysis of domains in your simulation trajectories by providing an automated workflow for the detection of lateral heterogeneities (i.e., liquid-ordered domains).
9+
# It is a versatile tool to handle different use case scenarios, such as simulations of asymmetric membranes or membranes including small proteins. It utilizes therefore unsupervised machine learning algorithms,
10+
# including Gaussian Mixture Models and Gaussian-based Hidden Markov Models, to detect ordered lipids based on their structural properties. Identified lipids are then clustered into domains using spatial autocorrelation analysis.
11+
# More details about the method can be found here: https://doi.org/10.1016/bs.mie.2024.03.006.
12+
#
13+
#------------------------------------------------------------
14+
# Required entries
15+
#------------------------------------------------------------
16+
## Name of the repository
17+
project_name: domhmm
18+
19+
## List of DomHMM's authors
20+
authors:
21+
- https://github.com/BioMemPhys-FAU/domhmm/blob/main/AUTHORS.md
22+
23+
## List of DomHMM's maintainers
24+
maintainers:
25+
- m-a-r-i-u-s
26+
- yusuferentunc
27+
- biomemphys
28+
29+
## What is DomHMM
30+
description: >
31+
TL;DR: DomHMM provides an automated workflow to identify liquid-ordered (Lo) domains from Molecular Dynamics simulations of bio-membranes. :-)
32+
Nano- and microdomains in lipid membranes are of great interest for understanding biological processes such as small molecule binding and signal transduction.
33+
Molecular Dynamics (MD) present a powerful tool for studying membranes with various lipid compositions at different levels of resolution.
34+
However, detecting these domains can be challenging, as most workflows are described in papers without available or maintained implementations.
35+
The MDAKit DomHMM faciliates the analysis of domains in your simulation trajectories by providing an automated workflow for the detection of lateral heterogeneities (i.e., liquid-ordered domains).
36+
It is a versatile tool to handle different use case scenarios, such as simulations of asymmetric membranes or membranes including small proteins. It utilizes therefore unsupervised machine learning algorithms,
37+
including Gaussian Mixture Models and Gaussian-based Hidden Markov Models, to detect ordered lipids based on their structural properties. Identified lipids are then clustered into domains using spatial autocorrelation analysis.
38+
39+
## Keywords that relate to DomHMM
40+
keywords:
41+
- membranes
42+
- molecular dynamics
43+
- nanodomains
44+
- microdomains
45+
- machine learning
46+
47+
license: GPL-2.0-or-later
48+
49+
## You can find DomHMM on our GitHub repository:
50+
project_home: https://github.com/BioMemPhys-FAU/domhmm
51+
52+
## You can find the documentation of DomHMM here:
53+
documentation_home: https://domhmm.readthedocs.io
54+
55+
documentation_type: UserGuide + API
56+
57+
src_install:
58+
- pip install git+https://github.com/BioMemPhys-FAU/domhmm@main
59+
60+
import_name: domhmm
61+
62+
python_requires: ">=3.9"
63+
64+
mdanalysis_requires: ">=2.0.0"
65+
66+
## The repositiory of DomHMM includes some unit tests to ensure that the package runs as intended. Please note that we are using pytest to run the tests.
67+
run_tests:
68+
- pytest --pyargs domhmm
69+
70+
test_dependencies:
71+
- mamba install pytest
72+
73+
## Computational Biology - Department Biologie - Friedrich-Alexander-Universität Erlangen-Nürnberg
74+
project_org: BioMemPhys-FAU
75+
76+
#------------------------------------------------------------
77+
# Optional entries
78+
#------------------------------------------------------------
79+
## List(str): a list of commands to use when installing the latest
80+
## release of the code. Note: only one installation method can currently
81+
## be defined. We suggest using mamba where possible (e.g.
82+
## mamba -c conda-forge install MYPROJECT
83+
## for a conda package installation).
84+
## Here we use a simple PyPi installation:
85+
# More to come!
86+
# install:
87+
# - git clone latest
88+
# - pip install .
89+
90+
development_status: Production/Stable
91+
92+
publications:
93+
- https://doi.org/10.1016/bs.mie.2024.03.006
94+
95+
# We welcome your feedback on the code or any other aspects of the project. :-)
96+
community_home: https://github.com/BioMemPhys-FAU/domhmm/discussions/
97+
98+
changelog: https://github.com/BioMemPhys-FAU/domhmm/blob/main/CHANGELOG.md

0 commit comments

Comments
 (0)