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.4.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.4-py3-none-any.whl (91.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scipion_em_membrain-3.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 d850b2beae0f4365f6847dcc0558dbfd52876d3ed520b56eb335320c7de36d3b
MD5 074c64871f8c22576e8581ba76b2fbb7
BLAKE2b-256 2afb9981f62bdee5e1c0314738e0d7c26986de0a03b9ac3c358fcc741649f39d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for scipion_em_membrain-3.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 24382c41db33db7e3d9241ae33fd676481d4de954eb42e1328bbbf0ca2ba4fc0
MD5 23e4f398b38b7f2347d8b1e52bf61d17
BLAKE2b-256 6302cbb0b2b521f39abb9a6bb8ef1162ea370e9e28c3a863184ed390c8ae2680

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