Skip to main content
Archived

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

This plugin provides a wrapper for TomoTwin software: Particle picking in Tomograms using triplet networks and metric learning

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

    • download repository

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

    scipion installp -p /path/to/scipion-em-tomotwin --devel

TomoTwin software will be installed automatically with the plugin but you can also use an existing installation by providing TOMOTWIN_ENV_ACTIVATION (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 below but depending on your conda version and shell you will need something different: CONDA_ACTIVATION_CMD = eval “$(/extra/miniconda3/bin/conda shell.bash hook)”

TOMOTWIN_ENV_ACTIVATION (default = conda activate tomotwin-0.9.1): Command to activate the TomoTwin environment. Tomotwin uses cuda-11.8, so you might want to activate specific CUDA libs via e.g. TOMOTWIN_ENV_ACTIVATION = . /etc/profile.d/lmod.sh && module load cuda/11.8 && conda activate tomotwin-0.9.1

TOMOTWIN_MODEL (default = software/em/tomotwin_model-092023/tomotwin_model_p120_092023_loss.pth): Path to the pre-trained model.

NAPARI_ENV_ACTIVATION (default = conda activate napari-0.4.19): Command to activate the Napari viewer environment.

Verifying

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

  • scipion tests tomotwin.tests.test_protocols_tomotwin.TestTomoTwinRefBased

  • scipion tests tomotwin.tests.test_protocols_tomotwin.TestTomoTwinClusterBased

Supported versions

0.8.0, 0.9.0b1, 0.9.1

Protocols

  • clustering-based picking (step 1)

  • clustering-based picking (step 2)

  • create tomo masks

  • reference-based picking

References

  1. TomoTwin: Generalized 3D Localization of Macromolecules in Cryo-electron Tomograms with Structural Data Mining. Gavin Rice, Thorsten Wagner, Markus Stabrin, Stefan Raunser. https://www.biorxiv.org/content/10.1101/2022.06.24.497279v1

Metadata

Release files for scipion-em-tomotwin 3.5.3

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-tomotwin 3.5.3
File Size Uploaded
scipion_em_tomotwin-3.5.3.tar.gz 157.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for scipion-em-tomotwin 3.5.3
File Interpreter ABI Platform
scipion_em_tomotwin-3.5.3-py3-none-any.whl Python 3 none any Details

Total release size: 328.1 kB

Release files / scipion_em_tomotwin-3.5.3.tar.gz

Download URL scipion_em_tomotwin-3.5.3.tar.gz
Size 157.8 kB
Tags Source
SHA-256 checksum
How to use checksums
11fda2b74acb53c9fccc3cc6d678f637768720788943b969e339fc4f36461f1a
BLAKE2b-256 checksum
How to use checksums
f9cb1841f5ccfe4c8d11876347c14d779cdc3fd5a0b8c57634a39959a8ce974c
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_tomotwin-3.5.3-py3-none-any.whl

Download URL scipion_em_tomotwin-3.5.3-py3-none-any.whl
Size 170.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0ac2fbd8224c12a17f07a2fcb5cc43b965962a9ad92df07652ac0ade2d6642f5
BLAKE2b-256 checksum
How to use checksums
1c5bfc92bf260b6521be5a211c54fcb80895de010952bf7b3b6027ec2a38ced1
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