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.0.tar.gz (89.6 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.0-py3-none-any.whl (91.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scipion_em_membrain-3.1.0.tar.gz
  • Upload date:
  • Size: 89.6 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.0.tar.gz
Algorithm Hash digest
SHA256 daf06a361fa3510f989134b157e06b852f8c52849812913fda5e8b55b35cf802
MD5 89282a7451366e25e709dfee013c7d98
BLAKE2b-256 e6ad638eeab06f72c0db15f0e2ae521dbc4f3185d84b5ecf707cca71eedce3fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for scipion_em_membrain-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2021eb9d6478ca4bd2aedf94afea0278834d97982a6ed5412285375110fb280f
MD5 d10a135ac65e3b4af884442ce4b6a151
BLAKE2b-256 b8e58c8efb548da52e579491ad01cacb4519f15057c38fd9add04f4cc7ed406a

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