Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

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

Metadata

Release files for scipion-em-susantomo 3.0b5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scipion-em-susantomo 3.0b5
File Size Uploaded
scipion_em_susantomo-3.0b5.tar.gz 39.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for scipion-em-susantomo 3.0b5
File Interpreter ABI Platform
scipion_em_susantomo-3.0b5-py3-none-any.whl Python 3 none any Details

Total release size: 97.4 kB

Release files / scipion_em_susantomo-3.0b5.tar.gz

Download URL scipion_em_susantomo-3.0b5.tar.gz
Size 39.2 kB
Tags Source
SHA-256 checksum
How to use checksums
e2edf2926cd86796047901501e676866a018462d4cade008809ecf2cf6c132cb
BLAKE2b-256 checksum
How to use checksums
2ac06fd2cb2b64e9b3804287fb4d9e15f3329dbf9398e2d14276e151d0241e54
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.18

Release files / scipion_em_susantomo-3.0b5-py3-none-any.whl

Download URL scipion_em_susantomo-3.0b5-py3-none-any.whl
Size 58.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7319ab6f08842fa21c350392b62a3176410dbb2ad257e4f0bcf88e12576bce84
BLAKE2b-256 checksum
How to use checksums
2a814a7c14e835d700074b31e697d0e715b0efdf620d2c8fe08b6384fcba1f53
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.18
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page