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.
IMPORTANT!
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)
When importing EER movies, you should specify dose per single EER frame during import step.
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:
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
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.6.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 this plugin will guess the right default binary from MotionCor2_1.6.4_CudaXY_Mar312023 (X is for cuda major version, Y for the minor). You can always set 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.
For an automatically updated installation of motioncor2 binaries, do not define neither MOTIONCOR2_HOME nor MOTIONCOR2_BIN.
To check the installation, simply run the following Scipion tests:
scipion test motioncorr.tests.test_protocols_motioncor2.TestMotioncor2AlignMovies
scipion test motioncorr.tests.test_protocols_tomo.TestMotioncor2TiltSeriesAlignMovies
Licensing
Motioncor2 is free for academic use only. For commercial use, please contact David Agard or Yifan Cheng for licensing:
Supported versions
1.5.0, 1.6.2, 1.6.3, 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.15.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c98c0a3514988370937f64d51bd678f72e5ba4f8886ef19098f863e2cb5f026 |
|
MD5 | 7eb3a2b0b4cf09fae5ac94cec8c42b59 |
|
BLAKE2b-256 | 2339817863fad4da56baa99e753749772cf2fd8138eb82976c96d066f72bc8da |
Hashes for scipion_em_motioncorr-3.15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40ca410668bd03a91b834629cbbe0c31f8fc5c9083ca020d03c1a9751fd6c437 |
|
MD5 | 8a91a1ddbd180ee2e500cd630e5444cf |
|
BLAKE2b-256 | 27d7bf8133d496a64458e972fcd3ca17362e344543d323af3e3da4bd1b7f00cf |