CellArchLab cryoET-scripts

Miscellaneous scripts for processing cryo-ET data

Currently the following scritps are available:

• ddw/ddw_pipeline
  • Dependencies:
    • DeepDeWedge
    • IMOD
• cryocare/cryocare_pipeline
  • Dependencies:
    • cryoCARE_pip
    • IMOD
• defocusgrad/defocusgrad
  • Dependencies:
    • Python 3.x and the following modules:
      • mrcfile
      • numpy
      • matplotlib
      • scipy
      • scikit-learn
    • IMOD
    • CTFFIND4
• isonet/isonet_pipeline
  • Dependencies:
    • IsoNet
• locspiral/locspiral_cli
  • Dependencies:
    • LocSpiral-LocBSharpen-LocBFactor-LocOccupancy
    • MATLAB
• tm/
  • tm_find_thresh: intended to be used with pytom-match-pick, STOPGAP or GAPSTOP, a different way of finding a suitable threshold for candidate particle extraction.
  • maxip_scoremaps.py: plots maximum intensity projections along the X, Y and Z axes to facilitate inspection of score maps.
• relion5/
  • Dependencies:
    • Python 3.x and the following modules:
      • starfile
      • numpy
  • rln5_assign_halfsets.py reassigns half-sets based on different assumptions about the underlying geometry of the particles. Especially useful for filaments and lattices or particles picked on surfaces.
  • rln5_to_artiax.py reassigns the rlnTomoName field to make ArtiaX-friendly STAR files.
  • rln5_to_imod.py converts a STAR file of particles to .mod format for quick inspection in IMOD.

Use --help to see details of each script.

Running the scripts

Type <scriptname> --help to see all the options available and their default values. For example:

isonet_pipeline --help

will show you how to run the isonet_pipeline script.

Important

You have to modify the lines in the scripts that start with module load to reflect how the programs are loaded in your cluster or computing environment. This could be simply modifying the PATH environment variable, sourcing another script, or loading a conda environment, for example. If the programs are already loaded in your environment you could simply delete or comment out these lines. The exact modifications required will depend on where you want to run the scripts.

Please consult with your local sysadmin or computational expert as needed. We cannot provide support for other computational environments.

Tip

You can run the pipeline scripts using the --subcmd bash option, which will run then locally. Furthermore, you can use this option to run the desired command line within a submission script customized for your HPC environment.