Skip to main content

Plugin to use membrain within the Scipion framework

Project description

This plugin implements protocols from the MemBrain family of software packages for analysis of membrane proteins in cryo-electron tomography.

Installation

The plugin is currently only available in development mode. To install, proceed with the following steps:

Clone this repo:

git clone https://github.com/scipion-em/scipion-em-membrain.git

Install this plugin in devel (editable) mode:

scipion3 installp -p /path/to/scipion-em-membrain --devel

Scipion will automatically install MemBrain and download any pre-trained models necessary for running it.

Configuration variables

There are some optional variables related to the MemBrain installation. For example, if you have installed MemBrain-seg outside of Scipion, you may define MEMBRAIN_SEG_ENV_ACTIVATION in your scipion.conf file for specifying an already existing conda environment or a script to be sourced:

MEMBRAIN_SEG_ENV_ACTIVATION = conda activate my-membrain-seg-env

Also, you can use the MEMBRAIN_SEG_MODEL environment variable to indicate the full path to a MemBrain-seg model downloaded externally:

MEMBRAIN_SEG_MODEL = /path/to/membrain-seg/model.ckpt

If these variables are not defined, default values will be used that will work with the latest version installed through Scipion.

Protocols

The following protocols are currently implemented:

  • Membrane segmentation using the MemBrain-seg module

Using GPU or CPU

By default, MemBrain protocols assume that a GPU card is available. If such a device is not found, protocols may still run using the CPU with parallel threads, but will be much slower.

References

<!– in JSB citation style: –>

  • Lamm, L., Zufferey, S., Righetto, R.D., Wietrzynski, W., Yamauchi, K.A., Burt, A., Liu, Y., Zhang, H., Martinez-Sanchez, A., Ziegler, S., Isensee, F., Schnabel, J.A., Engel, B.D., Peng, T., 2024. MemBrain v2: an end-to-end tool for the analysis of membranes in cryo-electron tomography. https://doi.org/10.1101/2024.01.05.574336

  • Lamm, L., Righetto, R.D., Wietrzynski, W., Pöge, M., Martinez-Sanchez, A., Peng, T., Engel, B.D., 2022. MemBrain: A deep learning-aided pipeline for detection of membrane proteins in Cryo-electron tomograms. Computer Methods and Programs in Biomedicine 224, 106990. https://doi.org/10.1016/j.cmpb.2022.106990

Contact information

If you experiment any problem, please contact us here: scipion-users@lists.sourceforge.net or open an issue.

We’ll be pleased to help.

Scipion Team

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

scipion_em_membrain-3.1.5.tar.gz (89.7 kB view details)

Uploaded Source

Built Distribution

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

scipion_em_membrain-3.1.5-py3-none-any.whl (91.1 kB view details)

Uploaded Python 3

File details

Details for the file scipion_em_membrain-3.1.5.tar.gz.

File metadata

  • Download URL: scipion_em_membrain-3.1.5.tar.gz
  • Upload date:
  • Size: 89.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for scipion_em_membrain-3.1.5.tar.gz
Algorithm Hash digest
SHA256 172b071f79968c6a0c3bf6d16e6780b4f1df7df0cf6b6750267fa7b166da0d1f
MD5 ee91f66dcfe904dadb37590a700f6369
BLAKE2b-256 d688a040b7f77ca7bd484e6bdc98f9722f396f768fd45fa3d1b12e70df047198

See more details on using hashes here.

File details

Details for the file scipion_em_membrain-3.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for scipion_em_membrain-3.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3b0fb0d6752e1f116223a1bf8232ac25a7255d8e75e5b65fada1aab6596bad55
MD5 f65a4dd40b6981729bdd3e09730aa776
BLAKE2b-256 8a417a6227740e60ce1cf0364d937f516b746d400d06d54185cebbd5ee133815

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