Skip to main content

MDAnalysis tool to calculate membrane curvature from MD simulations.

Project description

Membrane Curvature

Powered by MDAnalysis GitHub Actions Status codecov docs PyPI

MembraneCurvature is an MDAnalysis tool to calculate membrane curvature from Molecular Dynamics simulations.

Interested in becoming a maintainer? We welcome your passion and expertise to help shape and grow this open-source project! Please contact estefania@ojeda-e.com for more details.

Features

With MembraneCurvature you can:

  • Calculate mean and Gaussian curvature from MD simulations.
  • Derive 2D curvature profiles.
  • Live a happier life.

Installation

The main dependency in MembraneCurvature is MDAnalysis. You can find instructions to install the latest stable version of MDAnalysis via conda in the UserGuide.

MembraneCurvature is available via pip:

pip install membrane-curvature

To install from source:

git clone https://github.com/MDAnalysis/membrane-curvature.git
cd membrane-curvature
conda env create -f devtools/conda-envs/environment.yaml
conda activate membrane-curvature
python setup.py install

Some of the examples included in the MembraneCurvature documentation use test cases from MDAnalysisTests. To install the unit tests via conda:

conda install -c conda-forge MDAnalysisTests

or via pip:

pip install --upgrade MDAnalysisTests

⚠️ In comparison to the previous version, membrane-curvature==0.0.3 shows a significant improvement in performance, particularly notable for membrane-protein systems. Installing the last available version is highly encouraged.

Usage

This is a quick example on how to run MembraneCurvature:

import MDAnalysis as mda
from membrane_curvature.base import MembraneCurvature
from MDAnalysis.tests.datafiles import Martini_membrane_gro

universe = mda.Universe(Martini_membrane_gro)

curvature_upper_leaflet = MembraneCurvature(universe,
                                            select='resid 1-225 and name PO4',
                                            n_x_bins=8,
                                            n_y_bins=8,
                                            wrap=True).run()

# extract mean curvature
mean_upper_leaflet = curvature_upper_leaflet.results.z_surface

# extract mean curvature
mean_upper_leaflet = curvature_upper_leaflet.results.mean

# extract Gaussian
gaussian_upper_leaflet = curvature_upper_leaflet.results.gaussian

In this example, we use the PO4 beads in the upper leaflet as reference to derive a surface and calculate its respective mean and Gaussian curvature.

You can find more examples on how to run MembraneCurvature in the Usage page. To plot results from MembraneCurvature please check the Visualization page.

Documentation

To help you get the most out MembraneCurvature, we have documentation available where you can find:

  • The standard API documentation.
  • Quick examples of how to run Membrane Curvature in the Usage page.
  • Detailed explanation of the Algorithm implemented in MembraneCurvature.
  • Examples on how to plot the results obtained from MembraneCurvature in the Visualization page.

License

Source code included in this project is available in the GitHub repository https://github.com/MDAnalysis/membrane-curvature under the GNU Public License v3 , version 3 (see LICENSE).

MembraneCurvature was developed as a Google Summer of Code 2021 project with MDAnalysis and it is linked to a Code of Conduct.

Copyright (c) 2021-2022, Estefania Barreto-Ojeda

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

membrane_curvature-1.1.1.tar.gz (4.2 MB view details)

Uploaded Source

Built Distribution

membrane_curvature-1.1.1-py3-none-any.whl (4.2 MB view details)

Uploaded Python 3

File details

Details for the file membrane_curvature-1.1.1.tar.gz.

File metadata

  • Download URL: membrane_curvature-1.1.1.tar.gz
  • Upload date:
  • Size: 4.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for membrane_curvature-1.1.1.tar.gz
Algorithm Hash digest
SHA256 61883f8013284cffc29da3f98636ce6a57e3c9519b4bde63865513e5690feed7
MD5 49bf0d4467ceda98635372656765bc9d
BLAKE2b-256 6a5188e4a8677129052a273a6eb98413af38d02ca9e538749c3b7dddbaeba955

See more details on using hashes here.

File details

Details for the file membrane_curvature-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for membrane_curvature-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 597f098868d9d8ba7352d2a8369bbf8853cf9b8fdc4784c3253060edbef47d18
MD5 444cadcafb9172c6c24eed9745ca2dcb
BLAKE2b-256 c5d22a57fd1608615ab3e9b1fd0ac820ba2ea9bf362c32148c707af1086e6159

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