Skip to main content

Plugin to use Susan programs within the Scipion framework

Project description

This plugin provides wrappers for Susan software: subtomogram averaging (StA) workflow for CryoET based on sub-stacks of images instead of sub-volumes of tomograms. SUSAN uses substacks that are cropped on-the-fly from the aligned tilt-series stack and performs the CTF correction according to the selected operation (alignment or reconstruction). With this approach we decrease the computational resources needed in a typical subtomogram averaging pipeline, as we no longer need the CTF corrected stacks, the full tomogram reconstructions, or all the subtomograms in multiple binning stages.

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-susantomo
  1. Developer’s version

    • download repository

    git clone -b devel https://github.com/scipion-em/scipion-em-susantomo.git
    • install

    scipion installp -p /path/to/scipion-em-susantomo --devel
  • SUSAN sources will be downloaded and compiled automatically with the plugin, but you can also link an existing installation. Default installation path assumed is software/em/susan-0.1, if you want to change it, set SUSAN_HOME in scipion.conf file to the folder where the SUSAN is installed.

  • SUSAN installation requires CUDA libraries, gcc >= 9.x and cmake 3.22.x. OpenMPI is optional amd only required for running SUSAN on more than one cluster node. MATLAB is not required as this plugin uses Python API.

  • If you need to use CUDA different from the one used during Scipion installation (defined by CUDA_LIB), you can add SUSAN_CUDA_LIB variable to the config file.

  • If you have to use a MPI for SUSAN different from Scipion MPI, you can set SUSAN_MPI_BIN and SUSAN_MPI_LIB variables in the config file. At the moment MPI support in the plugin is not working.

Verifying

To check the installation, simply run one of the tests. A complete list of tests can be displayed by executing scipion test --show --grep susantomo

Supported versions

0.1

Protocols

  • ctf estimation

  • multi-reference alignment

  • average and reconstruct

  • create a subset

References

  1. Sánchez RM, Mester R, Kudryashev M. Fast Cross Correlation for Limited Angle Tomographic Data. In: Felsberg M., Forssén PE., Sintorn IM., Unger J. (eds) Image Analysis. SCIA 2019. Lecture Notes in Computer Science, vol 11482. Doi: 10.1007/978-3-030-20205-7_34

  2. R.M. Sánchez, R. Mester and M. Kudryashev. Fast Alignment of Limited Angle Tomograms by projected Cross Correlation. 2019 27th European Signal Processing Conference (EUSIPCO), 2019, pp. 1-5, doi: 10.23919/EUSIPCO.2019.8903041

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scipion_em_susantomo-3.0b5.tar.gz (39.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scipion_em_susantomo-3.0b5-py3-none-any.whl (58.2 kB view details)

Uploaded Python 3

File details

Details for the file scipion_em_susantomo-3.0b5.tar.gz.

File metadata

  • Download URL: scipion_em_susantomo-3.0b5.tar.gz
  • Upload date:
  • Size: 39.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for scipion_em_susantomo-3.0b5.tar.gz
Algorithm Hash digest
SHA256 e2edf2926cd86796047901501e676866a018462d4cade008809ecf2cf6c132cb
MD5 d256e1965fab5dce4ea42b2d1631cea5
BLAKE2b-256 2ac06fd2cb2b64e9b3804287fb4d9e15f3329dbf9398e2d14276e151d0241e54

See more details on using hashes here.

File details

Details for the file scipion_em_susantomo-3.0b5-py3-none-any.whl.

File metadata

File hashes

Hashes for scipion_em_susantomo-3.0b5-py3-none-any.whl
Algorithm Hash digest
SHA256 7319ab6f08842fa21c350392b62a3176410dbb2ad257e4f0bcf88e12576bce84
MD5 fb980593477dd5f51c9f419b785ad327
BLAKE2b-256 2a814a7c14e835d700074b31e697d0e715b0efdf620d2c8fe08b6384fcba1f53

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page