Skip to content

Pipeline for on-the-fly subtraction of filaments from cryo-EM micrographs.

License

Notifications You must be signed in to change notification settings

sami-chaaban/subflow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

subflow

  1. Workflow Overview
  2. Installation
  3. Usage
  4. Troubleshooting
  5. License

Workflow Overview

on-the-fly

  • Monitors incoming files for on-the-fly processing of movies, micrographs, and particles.

  • Aligns movie frames and estimates CTF values using Relion schemes (Burt et al., 2024).

  • Monitors preprocessed micrographs and picks filaments using crYOLO (Wagner et al., 2020).

  • Subtracts those filaments from micrographs using the lattice-subtraction scripts (Chai et al., 2022).

  • Filaments are split before subtraction to reduce artefacts induced by bending.

  • Allows for two rounds of filament picking and subtraction if requested.

  • Picks particles from subtracted micrographs using crYOLO (Wagner et al., 2019).

  • Allows viewing of micrographs and picked coordinates (if available) to monitor progress.

on-the-fly

  • Prepares Relion .star files with the modified paths to the subtracted micrographs.

  • Extracts particles, imports them to cryoSPARC (Punjani et al., 2017).

  • Performs heterogeneous refinement in cryoSPARC with user-defined volumes to extract a good class.

  • Converts the particles back to Relion .star format using pyem (Asarnow et al., 2019).

Installation

  • Set up a fresh conda environment with Python >= 3.9: conda create -n subflow python=3.9

  • Activate the environment: conda activate subflow

  • Install subflow: pip install subflow

  • Follow the instructions to install Relion and cryoSPARC

  • Install crYOLO and pyem into their own anaconda environments

  • Download the multi-curve-fitting and filament subtraction scripts.

  • Edit the config.json file in the subflow installation to point to the correct crYOLO and pyem files, as well as the multi-curve-fitting and subtraction scripts

Usage

Start the GUI by running the following with the conda environment active:

subflow &

Main window

  • After saving parameters to a file (e.g. subflow.txt), re-opening the GUI at a later date opens the previous parameters. Saving is not automatic.

Save parameters

  • Tabs with hollow circles can be run on-the-fly (i.e. monitor files from the previous step). They turn into a black dot once they are running.

Start link movies

  • Clicking twice on a tab reveals a display tab to view the resulting micrographs for that step.

First click

Second click

Troubleshooting

  • If Subflow crashes while Relion jobs are rerunning in the Preproc tab, they will continue to run. You can check this by running the Relion GUI. You may need to kill those jobs before being able to run Preproc again, or just continue in the Relion GUI.

  • Since cryosparc-tools is set to version 4.6.0 in the installation, your cryoSPARC installation must be 4.6.0. Otherwise cryosparc-tools needs to be downgraded or upgraded.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.

About

Pipeline for on-the-fly subtraction of filaments from cryo-EM micrographs.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages