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-motioncorr
Developer’s version
download repository
git clone -b devel https://github.com/scipion-em/scipion-em-motioncorr.git
install
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.1.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.1.1_CudaXY_05-27-2024 (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.TestMotioncorTiltSeriesAlignMovies
Licensing
Motioncor3 is provided under BSD-3-Clause license
Supported versions
motioncor3 1.0.1, 1.1.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).
Project details
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 327cd3355e4fe1565f5fe090aa5bc8a12c99f806f949932f7c536f47183acbb6 |
|
MD5 | b84722107db9e53f621cae4b6a685542 |
|
BLAKE2b-256 | 9dc574c98e30218e09d073e1862c13e3a79e8c697f9f0b985a85bb92ee2ad4f4 |
Hashes for scipion_em_motioncorr-3.16.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db26835f3306a93687d086808725a6222ee97c2eb3bc2f4a82552a4e858390e9 |
|
MD5 | 5b6df33bc3106a441eb1aef638a99b3f |
|
BLAKE2b-256 | 6bb9d4f152bbe213cff23e9e4a3e053efd504c3bc870c2f06c7ab9a9a452e65a |