Cryolo picker, training and custom model importer. Janni denoising.
Sphire Scipion plugin
This plugin allows to use cryolo within Scipion framework. So far we have implemented:
crYOLO particle picker
This plugin is able to install cryolo (which includes janni) and the generic models for both picking and denoising.
crYOLO is a pipeline for particle detection in cryo-electron microscopy images which is based on the deep learning object detection system “You Only Look Once” (YOLO).
JANNI (Just Another Noise 2 Noise Implementation) implements a neural network denoising tool based on deep learning.
Plugin scipion-em-sphire requires to have Conda (Anaconda or Miniconda) installed and not initialized in the shell.
Install this plugin in user mode:
It can be installed in user mode via Scipion main window (Configuration > Plugins) or using the command line:
scipion installp -p local/path/to/scipion-em-sphire
Install this plugin in developer mode:
scipion installp -p local/path/to/scipion-em-sphire --devel
The following steps presuppose that you have Anaconda or Miniconda installed on your computer. If you don’t have the optional SCIPION_HOME/config/scipion.conf create it like this
[PYWORKFLOW] CONDA_ACTIVATION_CMD = eval "$(/path/to/conda/bin/conda shell.bash hook)"
This also should work . /anaconda2/etc/profile.d/conda.sh. Note the conda initialization is tricky with csh shell and might not work.
If you wish to install the plugin with the default settings just go to plugin manager and install scipion-em-sphire. This will create the default environment named cryolo-x.x.x (where x.x.x is referred to the downloaded version of cryolo) for you.
You are ready to use crYOLO and JANNI. If you wish to change the environment name you can introduce CRYOLO_ENV_ACTIVATION variable in the ~/.config/scipion.conf variables section:
CRYOLO_ENV_ACTIVATION = conda activate cryoloenvname
Note: If you have a cryolo installation outside of Scipion and you want to use, follow these steps:
Install the plugin without the binaries:
scipion installp -p scipion-em-sphire --noBin
Create a symbolic link to the crYOLO environment following the naming convention “cryolo-x.x.x”, e.g:
ln -s <path_of_conda_environment> cryolo-1.8.0
Edit the CRYOLO_ENV_ACTIVATION variable as described above in the config file and rename the environment.
Downloaded crYOLO and JANNI general models can be found, respectively, in the following locations:
Running only with CPU
CrYOLO is able to run in CPU, however this is only recomended for predicting task, not trainning. For that reason, the CPU implementation is only enabled for the crYOLO-Picking protocol. In this protocol, both implementation are possible and you must select one of them in the GPU section of the from.
The CPU implementation of crYOLO is not installed by default. Therefore, to be able to run the CPU version of crYOLO-picking, you must install the cryoloCPU-[version] package in the Plugin Manager >> scipion-em-sphire or by running
scipion3 installb cryoloCPU
The CPU integration of crYOLO is installed under a conda environment called cryoloCPU-[version] . If you want to modify this environ name, please set the following variable in the scipion’s config file.
CRYOLO_ENV_ACTIVATION_CPU = conda activate cryoloCPU-envName
Running plugin tests
To check that everything is properly installed and configured, you might want to run some tests:
scipion test --grep sphire --run
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.