Plugin to use motioncor programs within the Scipion framework
Project description
This plugin allows to use motioncor3 program within the Scipion framework.
Motioncor3 is a GPU-accelerated program for correction of electron beam-induced sample motion. It is developed by Shawn Zheng.
IMPORTANT!
If you have imported movies with a gain file in DM4 format, you need to flip the gain reference upside-down in the motioncor protocol! (see details)
When importing EER movies, you should specify dose per single EER frame during import step.
When importing EER tilt-series movies, you should specify dose per tilt during import step. It is not relevant for motion-correction (no dose-weighting is done here), but will be used later on.
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 Motioncor 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:
Stable version
scipion installp -p scipion-em-motioncorrDeveloper’s version
download repository
git clone -b devel https://github.com/scipion-em/scipion-em-motioncorr.gitinstall
scipion installp -p /path/to/scipion-em-motioncorr --devel
Important: Starting from plugin v3.15, the config variables have been renamed. See: scipion3 config -p motioncorr
Motioncor binaries will be installed automatically with the plugin, but you can also link an existing installation.
Default installation path assumed is software/em/motioncor3-1.0.1, if you want to change it, set MOTIONCOR_HOME in scipion.conf file to the folder where the Motioncor3 is installed.
Depending on your CUDA version this plugin will guess the right default binary from MotionCor3_1.0.1_CudaXY_10-26-2023 (X is for cuda major version, Y for the minor). You can always set a different one by explicitly setting MOTIONCOR_BIN variable.
If you need to use CUDA different from the one used during Scipion installation (defined by CUDA_LIB), you can add MOTIONCOR_CUDA_LIB variable to the config file. Various binaries can be downloaded from the official UCSF website.
For an automatically updated installation of motioncor binaries, do not define neither MOTIONCOR_HOME nor MOTIONCOR_BIN.
To check the installation, simply run the following Scipion tests:
scipion test motioncorr.tests.test_protocols_motioncor.TestMotioncorAlignMovies
scipion test motioncorr.tests.test_protocols_tomo.TestMotioncorTiltSeriesAlignMoviesLicensing
Motioncor3 is provided under BSD-3-Clause license
Supported versions
motioncor3 1.0.1 motioncor2 1.6.4
Protocols
movie alignment
align tilt-series movies
References
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).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for scipion-em-motioncorr-3.16.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8e526186b012f681fd4cf475fcc2fc882776f65b099bef520266410bbee736b9 |
|
| MD5 | 3ef345a070b4d83d83018042f899ff3b |
|
| BLAKE2b-256 | 19525717d5030e36dfb26a3cf7dfd2e979559a8dac0b020cf7c7024fe8e8052f |
Hashes for scipion_em_motioncorr-3.16.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e57ba7dcf894b8597feed08c97ddfbd97d3e786051371f95aecffff59ff8aa34 |
|
| MD5 | 4fca1a159b667328bc574bd92a0008d8 |
|
| BLAKE2b-256 | 4e4359870c09cddfde8ea1654c3edea30b43eac652b2585122869b8bbe01063c |
