Skip to main content

Plugin to use Relion programs within the Scipion framework

Project description

This plugin provide wrappers around several programs of RELION software suite.

PyPI release License Supported Python versions SonarCloud quality gate Downloads

prod: prod

devel: devel

support: support

IMPORTANT!

If you have imported movies with a gain file in DM4 format, you need to flip the gain reference upside-down in the motion correction protocol! (bug details)

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-relion
  2. Developer’s version

    • download repository

    git clone https://github.com/scipion-em/scipion-em-relion.git
    • install

    scipion installp -p path_to_scipion-em-relion --devel

RELION sources will be downloaded and compiled automatically with the plugin, but you can also link an existing installation. Default installation path assumed is software/em/relion-3.1.1, if you want to change it, set RELION_HOME in scipion.conf file to the folder where the RELION is installed. If you need to use CUDA different from the one used during Scipion installation (defined by CUDA_LIB), you can add RELION_CUDA_LIB variable to the config file. Moreover, if you have to use a MPI for Relion different from Scipion MPI, you can set RELION_MPI_BIN and RELION_MPI_LIB variables in the config file.

To check the installation, simply run one of the tests. A complete list of tests can be displayed by executing scipion test --show --grep relion

Supported versions

3.1.0, 3.1.1

IMPORTANT: Relion-3.0 can be used with this plugin but we do not officially support it anymore, i.e. there will be no bugfixes for it.

Protocols

  • 2D classification

  • 3D auto-refine

  • 3D classification

  • 3D initial model

  • 3D multi-body

  • assign optics group

  • auto-picking

  • auto-picking LoG

  • bayesian polishing

  • center averages

  • compress movies

  • create 3d mask

  • ctf refinement

  • estimate gain to compress

  • expand symmetry

  • export coordinates

  • export ctf

  • export particles

  • local resolution

  • motion correction

  • particles extraction

  • post-processing

  • preprocess particles

  • reconstruct

  • remove preferential views

  • subtract projection

  • symmetrize volume

References

  1. Scheres et al., JMB, 2012

  2. Scheres et al., JSB, 2012

  3. Kimanius et al., eLife, 2016

  4. Zivanov et al., eLife, 2018

Project details


Release history Release notifications | RSS feed

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-relion-3.0.3.tar.gz (199.3 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_relion-3.0.3-py3-none-any.whl (255.5 kB view details)

Uploaded Python 3

File details

Details for the file scipion-em-relion-3.0.3.tar.gz.

File metadata

  • Download URL: scipion-em-relion-3.0.3.tar.gz
  • Upload date:
  • Size: 199.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.0 importlib_metadata/3.7.3 packaging/20.9 pkginfo/1.7.0 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for scipion-em-relion-3.0.3.tar.gz
Algorithm Hash digest
SHA256 11cf88a4e55a1655985700ddf1fc9106778692780b3a06929d501e3aab3fe29e
MD5 9a9b3e9686418dfa8890a1f1d63174b5
BLAKE2b-256 2ef8066a1fbcd343b40404e35eedfb31cc90a726422230949ce19c9cf50d3dec

See more details on using hashes here.

File details

Details for the file scipion_em_relion-3.0.3-py3-none-any.whl.

File metadata

  • Download URL: scipion_em_relion-3.0.3-py3-none-any.whl
  • Upload date:
  • Size: 255.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.0 importlib_metadata/3.7.3 packaging/20.9 pkginfo/1.7.0 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for scipion_em_relion-3.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e8a4d6b66503ed7b5bfe20281238aeac613f2133e55fd162ddbce91a1e52d614
MD5 1aa8d0cdcd81bd8ad1052995ec1b858b
BLAKE2b-256 5e2ec683eae34575429f49afcf23a456de40c7b60e4ebdf3cb7b4925746ca871

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