EuanPyle/relion4_tomo_robot

Automated workflow for preparing tilt series data for RELION 4.0.

THIS SOFTWARE IS NO LONGER BEING MAINTAINED AS IT HAS BEEN SUPERCEDED BY THE RELION 5.0 TOMOGRAPHY PIPELINE. PLEASE USE THAT INSTEAD -- AT THE TIME OF WRITING THERE IS NO 'OFFICIAL' PROTOCOL FOR IT BUT PLEASE WRITE TO ME AND I CAN PROVIDE ONE

Automated Workflow to Pre-Process Raw Tomography Data for RELION 4.0

Outline

This package contains functions to automate the processing of raw images from the microscope, all the way to tilt series import and tomograms reconstruction in RELION with a few single line commands using Matlab/Dynamo and Python.

We have also modified the automated tilt series alignment (TSA) in Dynamo to give much more accurate alignments, reducing the residual motion of fiducial markers to a minimum. Annecdotally, we have found that this function performs TSA as well as carefully manually picking gold beads in IMOD but with considerably less user effort!

Currently, the data requirements are that your data is recorded in a dose-symetric tilt scheme starting at 0 degrees, that your data contains fiducial markers, that your raw data follows a common naming convention, and that the raw data are in the .mrc or .tiff file formats. These requirements are subject to change based on user demand.

Functions Provided:

First, we use dautoalign4relion (partially based on autoalign4warp by Alister Burt) to carry out automated TSA.

Then we use generate_metadata to create the necessary metadata required by RELION 4.

We then estimate the CTF of the stacks by running import_ctf then using a CTFFIND4 wrapper called ctffind_wrapper.

You can now import into RELION!

We have integrated a wrapper of RELION's relion_tomo_reconstruct_tomogram function called reconstruct_tomo_wrapper to generate tomograms.

Now you can start picking particles!

If you use Dynamo to pick particles, you can convert the Dynamo table to a coordinates star file using this package.

Installation

Requirements

• Dynamo (tested on v1.1.509) activated in MATLAB
• IMOD (tested on v4.9.0)
• MATLAB (tested on R2020b)
• Python (3.0 or later)
• CTFFIND4 (tested on v4.0.17)
• MotionCor2 (tested on v1.0.5, but >=v1.1.0 should be used if your raw images are .tiff)

Download, Activation and Running

A detailed guide on how to use this workflow is given here.

In brief:

git clone https://github.com/EuanPyle/relion4_tomo_robot.git
cd relion4_tomo_robot
./install.sh

This requires git, which can be installed by your package manager if not already present in your system, for example...

sudo apt-get install git

You will be asked where you would like to install the package, the default location is...

/opt/relion4_tomo_robot

If not already, activate/load IMOD, Python 3, and MotionCor2 so these programs can be invoked from the command line.

Pre-process your data using the preprocessing.py function in the preprocessing directory where the program was installed. Copy the scripts in this directory into the directory where your raw data is. View the options for preprocessing using:

python preprocessing.py -h

Move the directories beginning TS_* into a directory named tilt_series (or whatever name you want) in your RELION project directory.

In Matlab, activate Dynamo with dynamo_activate. Activate the tomo_robot with run /path/to/install/relion_robot.m.

To see the required/optional inputs for each function:

help [function]

The available functions, in the order they should be used, are: dautoalign4relion, generate_metadata, import_ctf, ctffind_wrapper, and after importing tomograms into RELION, reconstruct_tomo_wrapper.