Skip to main content

Plugin to use cryoDRGN within the Scipion framework

Project description

This plugin provides a wrapper for cryoDRGN software: Deep Reconstructing Generative Networks for cryo-EM heterogeneous reconstruction.

PyPI release License Supported Python versions SonarCloud quality gate Downloads

Installation

You will need to use 3.0+ version of Scipion to be able to run these protocols. To install the plugin, you have two options:

  1. Stable version

scipion installp -p scipion-em-cryodrgn
  1. Developer’s version

    • download repository

    git clone -b devel https://github.com/scipion-em/scipion-em-cryodrgn.git
    • install

    scipion installp -p /path/to/scipion-em-cryodrgn --devel

cryoDRGN software will be installed automatically with the plugin but you can also use an existing installation by providing CRYODRGN_ENV_ACTIVATION (see below).

Important: you need to have conda (miniconda3 or anaconda3) pre-installed to use this program.

Configuration variables

CONDA_ACTIVATION_CMD: If undefined, it will rely on conda command being in the PATH (not recommended), which can lead to execution problems mixing scipion python with conda ones. One example of this could can be seen below but depending on your conda version and shell you will need something different: CONDA_ACTIVATION_CMD = eval “$(/extra/miniconda3/bin/conda shell.bash hook)”

CRYODRGN_ENV_ACTIVATION (default = conda activate cryodrgn-3.1.0): Command to activate the cryoDRGN environment.

Verifying

To check the installation, simply run the following Scipion test:

scipion test cryodrgn.tests.test_protocols_cryodrgn.TestWorkflowCryoDrgn

Supported versions

2.1.0-beta, 2.3.0, 3.1.0-beta

Protocols

  • analyze results

  • preprocess particles

  • training VAE

  • training ab initio

References

  1. Uncovering structural ensembles from single particle cryo-EM data using cryoDRGN. Laurel Kinman, Barrett Powell, Ellen Zhong, Bonnie Berger, Joey Davis. https://www.biorxiv.org/content/10.1101/2022.08.09.503342v1

  2. CryoDRGN: Reconstruction of heterogeneous cryo-EM structures using neural networks. Ellen D. Zhong, Tristan Bepler, Bonnie Berger, Joseph H. Davis. Nature Methods 18(2), 2021, 176-182. DOI 10.1038/s41592-020-01049-4

  3. Reconstructing continuous distributions of 3D protein structure from cryo-EM images. Ellen D. Zhong, Tristan Bepler, Joseph H. Davis, Bonnie Berger. ICLR 2020, https://arxiv.org/abs/1909.05215

  4. CryoDRGN2: Ab Initio Neural Reconstruction of 3D Protein Structures From Real Cryo-EM Images. Ellen D. Zhong, Adam Lerer, Joseph H. Davis, Bonnie Berger; Proceedings of the IEEE/CVF International Conference on Computer Vision (ICCV), 2021, pp. 4066-4075. https://openaccess.thecvf.com/content/ICCV2021/html/Zhong_CryoDRGN2_Ab_Initio_Neural_Reconstruction_of_3D_Protein_Structures_From_ICCV_2021_paper.html

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-cryodrgn-3.12.2.tar.gz (65.0 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_cryodrgn-3.12.2-py3-none-any.whl (69.5 kB view details)

Uploaded Python 3

File details

Details for the file scipion-em-cryodrgn-3.12.2.tar.gz.

File metadata

  • Download URL: scipion-em-cryodrgn-3.12.2.tar.gz
  • Upload date:
  • Size: 65.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.18

File hashes

Hashes for scipion-em-cryodrgn-3.12.2.tar.gz
Algorithm Hash digest
SHA256 870365b612d35cb7d321dee11b3960979af983089b123df86eabba645650bc7a
MD5 fda65853c3b405b0962ddb191540fd8a
BLAKE2b-256 7a8e559062f6cd6b29a71c61274b05c0c8debc91faf484737a1229b0b4724a6a

See more details on using hashes here.

File details

Details for the file scipion_em_cryodrgn-3.12.2-py3-none-any.whl.

File metadata

File hashes

Hashes for scipion_em_cryodrgn-3.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fe7eea1a8e15a0aac967b01ab29619f2a84cdc4f3c345ccff19bac9b7085994b
MD5 83e9ae2c12a4d69468e49c6d186174a5
BLAKE2b-256 39a6b3f2bc33d8748393ef9f1e71f64da304c0fc5ecb4f24ee6076cb973e51f9

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