Skip to main content

Plugin to use TomoTwin within the Scipion framework

Project description

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.5.1): Command to activate the TomoTwin environment.

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

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

Verifying

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

scipion test tomotwin.tests.test_protocols_tomotwin.TestTomoTwinRefPicking

Supported versions

0.3.0, 0.5.1

Protocols

  • reference-based picking

  • create tomo masks

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

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-tomotwin-3.1.tar.gz (158.7 kB view details)

Uploaded Source

Built Distribution

scipion_em_tomotwin-3.1-py3-none-any.whl (167.6 kB view details)

Uploaded Python 3

File details

Details for the file scipion-em-tomotwin-3.1.tar.gz.

File metadata

  • Download URL: scipion-em-tomotwin-3.1.tar.gz
  • Upload date:
  • Size: 158.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.18

File hashes

Hashes for scipion-em-tomotwin-3.1.tar.gz
Algorithm Hash digest
SHA256 52f6fffaed65e38a491170b48d2b7468c240311e84000008d10b26b774cef647
MD5 38255245802029598665bb082703e893
BLAKE2b-256 35484b27f859a5f1b782f36f3a98db1a0a703a6c3ab33733d9e66d2e09fb2739

See more details on using hashes here.

File details

Details for the file scipion_em_tomotwin-3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for scipion_em_tomotwin-3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2ea206ea72f1c29dc867d08f716a4e7fae7b26b31f7c9ed3b7f03efb64cae9b3
MD5 f3aba7414982b5ad3fa155a19d5f154b
BLAKE2b-256 3e9adda33de80ed1315a7c34a4299542b8145c33994549faff75d49c9dea61f1

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