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.1.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

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

Uploaded Source

Built Distribution

scipion_em_cryoassess-3.0.1-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scipion-em-cryoassess-3.0.1.tar.gz
Algorithm Hash digest
SHA256 a5c0c3a8b54c0b3bf9b34006a12181513676a81b7cd448f7c3b9f34b3ee49d57
MD5 793ed25c74d1641d10b2b65b741195c9
BLAKE2b-256 a563a74c436c362092882c7b82401bb1e0f18ba65ded00b490bc97f5ddd6e0fd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scipion_em_cryoassess-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 27.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.23.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.0

File hashes

Hashes for scipion_em_cryoassess-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 33a62c35d89af0634daa4a4d17afd5893aa15204c130a2992bf01f878cac1040
MD5 f52a5d5788582554d35cb36a5a71a0ea
BLAKE2b-256 7682bb85b98bc7bd6c58f7281c7c2e20d7f18880b91046224b51e9e2a9349c5d

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