Skip to main content

Calls MemGen service located at http://memgen.uni-saarland.de/api

Project description

Usage from shell

$ memgen example/chol.pdb membrane.pdb
Submitting [example/chol.pdb] to [memgen.uni-saarland.de/api]. Please wait...
Output saved as [membrane.pdb].
$ pymol membrane.pdb

Usage as a library

jupyter

About

MemGen generates multi-component lipid membranes for molecular dynamics simulations.

If you use structures generated by MemGen for a publicaiton, we kindly request that you cite this article:

Christopher J. Knight and Jochen S. Hub
MemGen: A general web server for the setup of lipid membrane simulation systems
Bioinformatics, 31:2897-2899 (2015), doi:10.1093/bioinformatics/btv292

MemGen is not restricted to certain force fields, lipid types, or MD simulation software. MemGen provides a PDB file of the membrane, which can be processed by any MD software.

After uploading structure files of single-lipid molecules, MemGen aligns these lipids along the Z-axis and creates a more compact structure of each one. This step is required to avoid atomic overlaps between adjacent lipids while setting up the membrane. Subsequently, MemGen generates the patch according to the requested number of lipids, mole fraction of lipid types, water molecules per lipid, and salt concentration. Counter-ions are always added to neutralize the system.

flowchart

MemGen should work with any all-atom or united-atom lipid, regardless of the type of head group or tails, or even the number of tails. We tested MemGen with lipids containing between 1 and 6 tails, numerous different lipid types, common and unusual sterols, alcohol and detergent molecules. Only coarse-grained lipids are not supported.

Note that the membrane structure provided by MemGen is highly ordered, so it requires energy minimization and careful equilibration. For membranes containing only one type of lipid plus water, 10 nanoseconds of equlibration are often enough. For multi-component membranes or systems containing ions, much longer equilibration may be required. Please check the equilibration from, for instance, the convergence of box dimensions and potential energy.

Options

$ memgen --help
usage: memgen [-h] [-c [RATIO ...]] [-a AREA_PER_LIPID] [-w WATER_PER_LIPID]
              [-n LIPIDS_PER_MONOLAYER] [-s ADDED_SALT] [-b {square,hexagonal}]
              [--png PNG] [--topology TOPOLOGY] [--server SERVER]
              input_pdbs [input_pdbs ...] output_pdb

positional arguments:
  input_pdbs            PDB files with lipids.
  output_pdb            Generated membrane.

optional arguments:
  -h, --help            show this help message and exit
  -c [RATIO ...], --ratio [RATIO ...]
                        Lipid concentration ratio. For example: 1 4 (same as 20 80). It means 20% of
                        the first lipid and 80% of the second. (default: None)
  -a AREA_PER_LIPID, --area-per-lipid AREA_PER_LIPID
                        Area per lipid (Ų) (default: 65)
  -w WATER_PER_LIPID, --water-per-lipid WATER_PER_LIPID
                        Water molecules per lipid (default: 35)
  -n LIPIDS_PER_MONOLAYER, --lipids-per-monolayer LIPIDS_PER_MONOLAYER
                        Lipids per monolayer (default: 64)
  -s ADDED_SALT, --added-salt ADDED_SALT
                        Added salt (milli molar) (default: 0)
  -b {square,hexagonal}, --box-shape {square,hexagonal}
                        Box shape (default: square)
  --png PNG             A small thumbnail depicting generated membrane. (default: None)
  --topology TOPOLOGY   Generated GROMACS topology file. (default: None)

Maintenance:
  --server SERVER       Hostname of MemGen REST API server. (default: memgen.uni-saarland.de)

Privacy

We don't store input or output of jobs submitted with this script.

The people behind MemGen

Christopher J. Knight developed the website's front-end, design, initial input processing, and lipid delineation. Jochen S. Hub designed the concept of MemGen and wrote the scripts involved in molecular modelling. This project was supported by the Deutsche Forschungsgemeinschaft (Emmy-Noehter Program and SFB 803/A12).

Troubleshooting

In case MemGen fails to generate a membrane, or the membrane has some flaws, you can create and describe an issue here. Two log files *.out.log and *.err.log are created on failure. Attach them to help us solve the issue.

Availablity

This script is just a terminal client to a web service located at http://memgen.uni-saarland.de. As a consequence:

  • It needs Internet connection to work.
  • Older versions of this package might stop working at some point (try updating the package).
  • Our server might be temporarily down.

In case you are feeling insecure with this, there is also an off-line version of MemGen available.

Maintenance

Development and publishing to 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

memgen-0.0.1b3.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

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

memgen-0.0.1b3-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file memgen-0.0.1b3.tar.gz.

File metadata

  • Download URL: memgen-0.0.1b3.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for memgen-0.0.1b3.tar.gz
Algorithm Hash digest
SHA256 0ad34f51e476d105d11121e6549c22f79a26c41c16fee366cc72d0dac8a2fd72
MD5 1c975c0ba43195b060f51c486391db08
BLAKE2b-256 a86f24f71769e60b30e4d870badd67d8a1d788127dd02f6aaa1258978e7c6286

See more details on using hashes here.

File details

Details for the file memgen-0.0.1b3-py3-none-any.whl.

File metadata

  • Download URL: memgen-0.0.1b3-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for memgen-0.0.1b3-py3-none-any.whl
Algorithm Hash digest
SHA256 18cd210195538893093fa09f7c7f42ebe5e78f7fb46c1a30365215bd94849d6a
MD5 6f27170f82816146b8c243d9440cfe30
BLAKE2b-256 3a506dab39387624e97eb880cc7e89f020d05bbaa5971250e3e03a19015c27bb

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