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.3, 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.3_CudaXY_Feb18_2023 (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 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.4.0, 1.4.2, 1.4.4, 1.4.5, 1.4.7, 1.5.0, 1.6.2, 1.6.3
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.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49dbc024458fb3f32e798295890ea5baa58277db3f7e29a573cbd84e42dd58b4 |
|
MD5 | b4659b8a7aacbfefec548f84992704d4 |
|
BLAKE2b-256 | 13027f8bfa55c1bf8157e834c1472f3589653c3f6f388c6fc602626705876586 |
Hashes for scipion_em_motioncorr-3.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d20347d281b6a6e2bd1e77916a3de76bf90d1edc9a1761bb4a7cd965d77ed17f |
|
MD5 | 6500efb2144ac44dbafeeb46c184b4ef |
|
BLAKE2b-256 | 8456417d1ea7c9a2971489a26b12529934cd3a1638bf6bbc35fc51d3543f8bf6 |