Skip to content

Plugin to use 3DFSC program within the Scipion framework

License

Notifications You must be signed in to change notification settings

scipion-em/scipion-em-fsc3d

Repository files navigation

FSC3D plugin

This plugin provides a wrapper for 3DFSC program developed at Salk Institute and NYSBC.

PyPI release License Supported Python versions SonarCloud quality gate Downloads

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:

  1. Stable version
scipion installp -p scipion-em-fsc3d
  1. Developer's version

    • download repository
    git clone -b devel https://github.com/scipion-em/scipion-em-fsc3d.git
    
    • install
    scipion installp -p /path/to/scipion-em-fsc3d --devel
    

FSC3D software will be installed automatically with the plugin but you can also use an existing installation by providing FSC3D_HOME (see below).

Important: you need to have conda (miniconda3 or anaconda3) pre-installed to use this program.

Configuration variables

CONDA_ACTIVATION_CMD: If undefined, it will rely on conda command being in the PATH (not recommended), which can lead to execution problems mixing scipion python with conda ones. One example of this could can be seen bellow but depending on your conda version and shell you will need something different: CONDA_ACTIVATION_CMD = eval "$(/extra/miniconda3/bin/conda shell.bash hook)"

FSC3D_HOME (default = software/em/fsc3D-3.0): Path where the 3DFSC is installed.

FSC3D_ENV_ACTIVATION (default = conda activate fsc3D-3.0): Command to activate the 3DFSC environment.

Verifying

To check the installation, simply run the following Scipion test:

scipion test fsc3d.tests.test_protocols_3dfsc.Test3DFSC

Supported versions

3.0 (modified for Scipion, see https://github.com/azazellochg/fsc3D)

Protocols

  • resolution estimation

References

  1. Yong Zi Tan, Philip R Baldwin, Joseph H Davis, James R Williamson, Clinton S Potter, Bridget Carragher & Dmitry Lyumkis. Addressing preferred specimen orientation in single-particle cryo-EM through tilting. Nature Methods volume 14, pages 793–796 (2017).