Skip to main content

Plugin to use SUSAN 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.0b2.tar.gz (41.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file scipion-em-susantomo-3.0b2.tar.gz.

File metadata

  • Download URL: scipion-em-susantomo-3.0b2.tar.gz
  • Upload date:
  • Size: 41.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for scipion-em-susantomo-3.0b2.tar.gz
Algorithm Hash digest
SHA256 13d60bef2c3fa9eafb27a4173d51a07d195902b3694d5bae6415b1e614bbb517
MD5 6879c5bd4cc8cc65147af4ebbec4662b
BLAKE2b-256 10b97182c3c4fa01234a3d6f5c8faee08059dbe158c419c47a735e318edecb03

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for scipion_em_susantomo-3.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 b993d711af946629fc8a9c7beccfebb0cb088ff2b14b5d71a3d98b5416901afe
MD5 dbe75141f1d7f36b600e2024d2b7100e
BLAKE2b-256 319912a4ad559e1df8a1ad963719d6fcc30057852db5f79d2225caf1f36b85bd

See more details on using hashes here.

Supported by

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