Skip to main content

Plugin to use Relion programs within the Scipion framework

Project description

This plugin provide wrappers around several programs of RELION software suite.

PyPI release License Supported Python versions SonarCloud quality gate Downloads
prod: prod devel: devel support: support

IMPORTANT NOTES!

  1. If you have imported movies with a gain file in DM4 format, you need to flip the gain reference upside-down in the motion correction protocol! (bug details)
  2. We found the bug causing omission of the gain reference during polishing job. This affects all plugin versions prior to 3.0.0. Starting from 3.0.0, if you have provided a gain reference or defects file during movie import or motion correction, please make sure to run first “assign optics groups” protocol for aligned movies, specifying the gain file etc. Currently, Scipion has no other way of knowing if you have e.g. rotated the gain during motion correction. Output movies then can be used in this polishing protocol.
  3. EER movies processing is not available yet, as it requires Scipion core changes.

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-relion
    
  2. Developer’s version

    • download repository
    git clone https://github.com/scipion-em/scipion-em-relion.git
    
    • install
    scipion installp -p path_to_scipion-em-relion --devel
    

RELION sources will be downloaded and compiled automatically with the plugin, but you can also link an existing installation. Default installation path assumed is software/em/relion-3.1.2, if you want to change it, set RELION_HOME in scipion.conf file to the folder where the RELION is installed. If you need to use CUDA different from the one used during Scipion installation (defined by CUDA_LIB), you can add RELION_CUDA_LIB variable to the config file. Moreover, if you have to use a MPI for Relion different from Scipion MPI, you can set RELION_MPI_BIN and RELION_MPI_LIB variables in the config file.

To check the installation, simply run one of the tests. A complete list of tests can be displayed by executing scipion test --show --grep relion

Supported versions

3.1.0, 3.1.1, 3.1.2

Protocols

  • 2D classification
  • 3D auto-refine
  • 3D classification
  • 3D initial model
  • 3D multi-body
  • assign optics groups
  • auto-picking (reference-based)
  • auto-picking LoG
  • bayesian polishing
  • center averages
  • clean project
  • compress movies
  • create 3d mask
  • crop / resize volumes
  • ctf refinement
  • estimate gain to compress
  • expand symmetry
  • export coordinates
  • export ctf
  • export particles
  • local resolution
  • motion correction
  • particles extraction
  • post-processing
  • preprocess particles
  • reconstruct
  • remove preferential views
  • subtract projection
  • symmetrize volume

References

  1. Scheres et al., JMB, 2012
  2. Scheres et al., JSB, 2012
  3. Kimanius et al., eLife, 2016
  4. Zivanov et al., eLife, 2018

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for scipion-em-relion, version 3.1.3
Filename, size File type Python version Upload date Hashes
Filename, size scipion_em_relion-3.1.3-py3-none-any.whl (260.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size scipion-em-relion-3.1.3.tar.gz (206.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page