Skip to main content

Plugin to use cryoassess within the Scipion framework

Project description

This plugin provide a wrapper around Cryoassess software tools for automatic micrograph and 2D classes assessment.

PyPI release License Supported Python versions SonarCloud quality gate Downloads

prod: prod

devel: devel

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-cryoassess
  1. Developer’s version

    • download repository

    git clone https://github.com/scipion-em/scipion-em-cryoassess.git
    • install

    scipion installp -p path_to_scipion-em-cryoassess --devel

Cryoassess software will be installed automatically with the plugin but you can also use an existing installation by providing CRYOASSESS_ENV_ACTIVATION (see below). You also have to download training models separately (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)”

CRYOASSESS_ENV_ACTIVATION (default = conda activate cryoassess-0.2.0): Command to activate the cryoassess environment.

The deep-learning models can be downloaded from authors’ website and set with the following variables:

CRYOASSESS_MODEL_MIC (default = software/em/cryoassess-models/micassess_051419.h5)

CRYOASSESS_MODEL_2D (default = software/em/cryoassess-models/2dassess_062119.h5)

Verifying

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

scipion test cryoassess.tests.test_protocols_cryoassess.TestCryoassess

Supported versions

0.1.0, 0.2.0

Protocols

  • assess micrographs

  • assess 2D classes

References

  1. High-Throughput Cryo-EM Enabled by User-Free Preprocessing Routines. Yilai Li, Jennifer N.Cash, John J.G. Tesmer, Michael A.Cianfrocco. Structure 2020, Volume 28 (7), Pages 858-869.e3

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-cryoassess-3.0.2.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

scipion_em_cryoassess-3.0.2-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

Details for the file scipion-em-cryoassess-3.0.2.tar.gz.

File metadata

  • Download URL: scipion-em-cryoassess-3.0.2.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.23.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.9.1

File hashes

Hashes for scipion-em-cryoassess-3.0.2.tar.gz
Algorithm Hash digest
SHA256 91dbbd86178d9cbcd6e532aae80a9bd91deb4dd9a949e17c6dfc45777f0c9cd2
MD5 7bef819f92dbd3177a5f34d22f052955
BLAKE2b-256 31f40cb0d75abf5e3c9edfbcd14e2d741d0ea72dd9601902569c3cf8e02d4b44

See more details on using hashes here.

File details

Details for the file scipion_em_cryoassess-3.0.2-py3-none-any.whl.

File metadata

  • Download URL: scipion_em_cryoassess-3.0.2-py3-none-any.whl
  • Upload date:
  • Size: 27.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.23.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.9.1

File hashes

Hashes for scipion_em_cryoassess-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8bfe9fea70c2aca6939507a60c1ad9934e34c6ed2ed5651fd1110abc4dfcede0
MD5 940c335eacf7d302c05deb60ce32dd55
BLAKE2b-256 c8d75074e63781c48d699f2a7167d7b80ae9990e12cc5e45c332e501d0314e08

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page