Skip to main content

Plugin to use deepfinder within the Scipion framework

Project description

Deepfinder plugin for Scipion

PyPI release License Supported Python versions Downloads

Deepfinder provides a deeplearning picking workflow for cryo-electron microscopy tomography data.

Installation

The plugin can be installed in user (stable) or developer (latest, may be unstable) mode:

1. User (stable) version::

scipion3 installp -p scipion-em-deepfinder

2. Developer (latest, may be unstable) version::

  • Clone the source code repository:

git clone https://github.com/scipion-em/scipion-em-deepfinder.git
  • Move to devel branch:

git checkout devel
  • Install:

scipion3 installp -p local/path/to/scipion-em-deepfinder --devel

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 can be seen below but depending on your conda version and shell you will need something different: CONDA_ACTIVATION_CMD = eval “$(/extra/anaconda/bin/conda shell.bash hook)”

DF_ENV_ACTIVATION: (default = conda activate deepfinder-0.2): Command to activate the DeepFinder environment.

DF_HOME: (default = ScipionHome/Software/em/deepfinder-0.2): Location of the DeepFinder package.

Protocols

The integrated protocols are:

  1. Annotate: manual annotation of macromolecules in the tomograms, using a visual tool.

  2. Generate sphere targets: generates segmentation maps from annotations. These segmentation maps will be used as targets to train DeepFinder

  3. Training.

  4. Segment: segmentation of tomograms, using a trained neural network.

  5. Cluster: analyses the segmentation maps and outputs particle coordinates and class.

  6. Import DeepFinder coordinates.

  7. Import DeepFinder Training model.

Tests

The installation can be checked out running some tests. To list all of them, execute:

scipion3 tests --grep deepfinder

To run all of them, execute:

scipion3 tests --grep deepfinder --run

To run a specific test, for example, the tests to check the sphere targets generation (the following command can be copied from the test list displayed when listing the tests, as explained above):

scipion3 tests deepfinder.tests.test_deepfinder.TestDeepFinderGenSphereTarget

Video tutorials

A playlist was created in I2PC Youtube channel to show how to use Deepfinder plugin in Scipion.

References

Contact information

If you experiment any problem, please contact us here: scipion-users@lists.sourceforge.net or open an issue.

We’ll be pleased to help.

Scipion Team

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_deepfinder-3.2.1.tar.gz (76.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_deepfinder-3.2.1-py3-none-any.whl (90.6 kB view details)

Uploaded Python 3

File details

Details for the file scipion_em_deepfinder-3.2.1.tar.gz.

File metadata

  • Download URL: scipion_em_deepfinder-3.2.1.tar.gz
  • Upload date:
  • Size: 76.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_deepfinder-3.2.1.tar.gz
Algorithm Hash digest
SHA256 b3bb8fa96b3c0b5a2b8048b905faebf409a498e7ee5d5d19f5b2223c7c0bffe8
MD5 f9e6a81c3a79a5660729f9e99e66b7b2
BLAKE2b-256 44bf42fc09b952bf1859152666b1937aefc8042ba4865b9f18b7b259b503477a

See more details on using hashes here.

File details

Details for the file scipion_em_deepfinder-3.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for scipion_em_deepfinder-3.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6615c4b36499b304da6daf578d2d3769ccdb094900016ae76846a957589cde26
MD5 8ac333ed4a626d1568c416727d507c77
BLAKE2b-256 14fa3c3c3615b9673850e42475347c3b17e681ea112f6a7848866e79b3f45234

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