Skip to main content

Plugin to use motioncorr programs within the Scipion framework

Project description

This plugin allows to use motioncor2 program within the Scipion framework.

Motioncor2 is a GPU-accelerated program for correction of electron beam-induced sample motion. It is developed by Shawn Zheng.

PyPI release License Supported Python versions SonarCloud quality gate Downloads

IMPORTANT!

  1. If you have imported movies with a gain file in DM4 format, you need to flip the gain reference upside-down in the motioncor2 protocol! (see details)
  2. When importing EER movies, you should specify dose per single EER frame during import step.
  3. If you are processing EER movies and providing *.gain reference file camera defects will be automatically extracted from the gain file header and converted to Motioncor2 format. This step is omitted if you provide a defects file yourself.

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

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

Motioncor2 binaries will be installed automatically with the plugin, but you can also link an existing installation. Default installation path assumed is software/em/motioncor2-1.4.4, if you want to change it, set MOTIONCOR2_HOME in scipion.conf file to the folder where the Motioncor2 is installed. Depending on your CUDA version you might want to change the default binary from MotionCor2_1.4.4_Cuda101-08-11-2021 to a different one by explicitly setting MOTIONCOR2_BIN variable. If you need to use CUDA different from the one used during Scipion installation (defined by CUDA_LIB), you can add MOTIONCOR2_CUDA_LIB variable to the config file. Various binaries can be downloaded from the official UCSF website.

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

scipion test motioncorr.tests.test_protocols_motioncor2.TestMotioncor2AlignMovies

Licensing

Motioncor2 is free for academic use only. For commercial use, please contact David Agard or Yifan Cheng for licensing:

Supported versions

1.2.6, 1.3.0, 1.3.1, 1.3.2, 1.4.0, 1.4.2, 1.4.4

Protocols

  • movie alignment
  • align tilt-series movies

References

  1. Shawn Q Zheng, Eugene Palovcak, Jean-Paul Armache, Kliment A Verba, Yifan Cheng & David A Agard. MotionCor2: anisotropic correction of beam-induced motion for improved cryo-electron microscopy. Nature Methods volume 14, pages 331–332 (2017).

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-motioncorr, version 3.2
Filename, size File type Python version Upload date Hashes
Filename, size scipion_em_motioncorr-3.2-py3-none-any.whl (42.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size scipion-em-motioncorr-3.2.tar.gz (37.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate 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