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

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.0, 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

We are still working towards stable plugin release, so some things might not work yet. Handling optics groups needs more testing, you are welcome to be a volunteer.

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

Uploaded Python 3

File details

Details for the file scipion-em-relion-3.0.0b6.tar.gz.

File metadata

  • Download URL: scipion-em-relion-3.0.0b6.tar.gz
  • Upload date:
  • Size: 195.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.23.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for scipion-em-relion-3.0.0b6.tar.gz
Algorithm Hash digest
SHA256 b0f1263109b5d00fef7164c2e17dbee89f43f317c0dcf73c04962d8dc5ce2a0d
MD5 069f14862c224812dfc2ced0de928ceb
BLAKE2b-256 af3d5f49eda775d522913e1a66317125ba609bb96d9ea588c0bf9f80fd50a987

See more details on using hashes here.

File details

Details for the file scipion_em_relion-3.0.0b6-py3-none-any.whl.

File metadata

  • Download URL: scipion_em_relion-3.0.0b6-py3-none-any.whl
  • Upload date:
  • Size: 250.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.23.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for scipion_em_relion-3.0.0b6-py3-none-any.whl
Algorithm Hash digest
SHA256 4119619d613ee6452755c1523038c99e00cb1345231803d258bad8fb66cca7de
MD5 3d0aa6c869fb656a1e54fd1cb2a89c28
BLAKE2b-256 c54b6d049ba41f7ede2107173620a9d7b36fb017781d15300cb276a802b1799d

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