Skip to main content

Plugin to use Topaz within the Scipion framework

Project description

This plugin allows to use Topaz programs within the Scipion framework. It can denoise, pre-process micrographs and pick particles within Scipion.

Topaz is a pipeline for particle detection in cryo-electron microscopy images which uses convolutional neural networks trained from positive and unlabeled examples.

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

    It can be installed in user mode via Scipion plugin manager (Configuration > Plugins) or using the command line:

    scipion installp -p scipion-em-topaz
  2. Developer’s version

    • download repository

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

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

Topaz software will be installed automatically with the plugin but you can also use an existing installation by providing TOPAZ_ENV_ACTIVATION (see below).

Important: you need to have conda (miniconda3 or anaconda3) pre-installed to use this program.

To check the installation you can run the plugin’s tests:

scipion tests topaz.tests.test_protocol_topaz.TestTopaz

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)”

TOPAZ_ENV_ACTIVATION (default = conda activate topaz-0.2.5): Command to activate the Topaz environment.

Supported versions

0.2.3, 0.2.4, 0.2.5

Protocols

  • import training model

  • picking

  • training

References

  • Bepler, T. et al. Positive-unlabeled convolutional neural networks for particle picking in cryo-electron micrographs. arXiv (2018).

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_topaz-3.1.1.tar.gz (27.8 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_topaz-3.1.1-py3-none-any.whl (37.1 kB view details)

Uploaded Python 3

File details

Details for the file scipion_em_topaz-3.1.1.tar.gz.

File metadata

  • Download URL: scipion_em_topaz-3.1.1.tar.gz
  • Upload date:
  • Size: 27.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for scipion_em_topaz-3.1.1.tar.gz
Algorithm Hash digest
SHA256 f5e5c26383dbc452739b2606673b694185fd36a23b545c84fb5f2ce6c3c1578c
MD5 a812f4fc241962c85ecb84a05d83a2f4
BLAKE2b-256 8f44096cefb46b4b8eb7d8503b49ce29a527cfd45d2dac41c12b8bb64ca5825d

See more details on using hashes here.

File details

Details for the file scipion_em_topaz-3.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for scipion_em_topaz-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8a191e3352b0df4e384c8026cc026d8443d1904a3f3f390656df12b5bbcdd42f
MD5 4a4c99aadf859f4b3297f6e5886b9c5d
BLAKE2b-256 f6987540ddc8471a8ce5a3ea290e5792dd0a2dfd24657ac44359f82ab410233f

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