Skip to main content

Analyse MD simulations of lipids with python

Project description

A python toolkit for the analyis of lipid membrane simulations

lipyphilic is free software licensed under the GNU General Public License v2 or later (GPLv2+)

Overview

lipyphilic is a set of tools for analysing MD simulations of lipid bilayers. It is an object-oriented Python package built directly on top of MDAnalysis, and makes use of NumPy, SciPy and pandas for efficient computation. The analysis classes are designed with the same interface as those of MDAnalysis - so if you know how to use analysis modules in MDAnalysis then you know how to use lipyphilic!

Analysis tools in lipyphilic include: identifying sterol flip-flop events, calculating domain registration over time, and calculating local lipid compositions. These tools position lipyphilic as complementary to, rather than competing against, existing membrane analysis software such as MemSurfer and FatSlim.

Check out the Basic Usage example to see how to use lipyphilic, and see the Analysis tools section for detailed information and exmaples on each tool.

Citing

If you use lipyphilic in your project, please cite MDAnalysis and if you use the Area Per Lipid tool please also cite Freud.

There is currently no paper describing lipyphilic, but we’re working on it. In the meantime, if you like what we do, please tell everyone you know to check out lipyphilic! And if there are things you think we could improve, features you would like to see added, or pesky bugs you that need to be fixed, please raise an issue on github.

Full documentation

Head to lipyphilic.readthedocs.io, where you will find the full documentation of lipyphilic’s API as well as examples of how to use the analysis tools.

Acknowlegment

The respository structure of lipyphilic is based on the PyLibrary Cookeicutter template.

lipyphilic CHANGELOG

0.3.1 (2021-02-27)

  • Add support for numpy 1.20

0.3.0 (2021-02-26)

  • Fix neighbour calculation for non-sequential residue indices Fixes #11

  • Added a tool to calculate interleaflet registration

0.2.0 (2021-02-23)

  • Improved documentation

  • Add method to count number of each neighbour type

  • Add functionality to find neighbouring lipids

0.1.0 (2021-02-17)

  • Add functionality to find flip-flop events in bilayers

  • Add functionality to calculate area per lipid

  • Add functionality to find assign lipids to leaflets in a bilayer

0.0.0 (2021-02-08)

  • First release on PyPI.

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

lipyphilic-0.3.1.tar.gz (849.8 kB view details)

Uploaded Source

Built Distribution

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

lipyphilic-0.3.1-py3-none-any.whl (55.5 kB view details)

Uploaded Python 3

File details

Details for the file lipyphilic-0.3.1.tar.gz.

File metadata

  • Download URL: lipyphilic-0.3.1.tar.gz
  • Upload date:
  • Size: 849.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.6

File hashes

Hashes for lipyphilic-0.3.1.tar.gz
Algorithm Hash digest
SHA256 c10121f1f4e2dcac9978e269ce930cc56de879fd8b19a84f2b2dfac7293a391c
MD5 48d870b06c1b55c73c3029b546f57400
BLAKE2b-256 746b4689d2348c9f82f09217dd8f897c6ff0cd2c2aa4683f88690181cf13a1b1

See more details on using hashes here.

File details

Details for the file lipyphilic-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: lipyphilic-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 55.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.6

File hashes

Hashes for lipyphilic-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 488f37139cbb57651289e6ff250e1da8f5a5e59be606757e69820cef862000e9
MD5 bc67a40c3f786b9cc76e999155003987
BLAKE2b-256 9cb3bb948aa31907230a1c2df03258b8d610b17c6331be4540ff4bba87299c68

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