Skip to content

scipion-em/scipion-em-deepfinder

Repository files navigation

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

About

Scipion plugin for deepfinder (tomography picker)

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages