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.0.tar.gz (27.2 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.0-py3-none-any.whl (36.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scipion_em_topaz-3.1.0.tar.gz
  • Upload date:
  • Size: 27.2 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.0.tar.gz
Algorithm Hash digest
SHA256 e94b0cb37ce705519414d13b05e055558cafdf61b7823ca66ffa97124e4571ac
MD5 40048fc4df2f6dda618a24c8856c9961
BLAKE2b-256 2b3b2f09f6f2cd5fe5e159f576b70e9de8a986abce0949365ca29c01b5fc4e27

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for scipion_em_topaz-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62fd56665b3b5699a95c16b9534a5aac2f57f7d896ec2502772795172add2caa
MD5 73a0bcfdeb3abda42d4c73c331302f2e
BLAKE2b-256 d0bb86014da27bc1d1440b94f569fc03369231703fe8b0cf62b46710f0c4ea4a

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