Skip to main content

Plugin to use cryoSPARC2 programs within the Scipion framework

Project description

This plugin allows to use cryoSPARC2 programs within the Scipion framework

CryoSPARC is a backend and frontend software system that provides data processing and image analysis capabilities for single particle cryo-EM, along with a browser based user interface and command line tools.

You will need to use 2.0.0 version of Scipion to run these protocols.

  • 2D Classification: Classify particles into multiple 2D classes to facilitate stack cleaning and removal of junk particles. Also useful as a sanity check to investigate particle quality.

  • 3D Ab-Initio Reconstruction: Reconstruct a single (homogeneous) or multiple (heterogeneous) 3-D maps from a set of particles, without any initial models or starting structures required.

  • 3D Homogeneous Refinement: Rapidly refine a single homogeneous structure to high-resolution and validate using the gold-standard FSC.

  • 3D Non uniform Refinement: Apply non-uniform refinement to acheive higher resolution and map quality

  • Particle Subtraction: Subtract projections of a masked volume from particles.

  • 3D Local Refinement Naive local refinement.

Installing the plugin

In order to install the plugin follow these instructions:

  1. Install the plugin

scipion installp -p scipion-em-cryosparc2

or through the plugin manager by launching Scipion and following Configuration >> Plugins

  1. Install CryoSPARC software

CryoSPARC v2 software will NOT be installed automatically with the plugin. The independent installation of CryoSPARC software suite by the user is required before running the programs.

To install CryoSPARC v2 software review the detailed system requirements and install instructions available here. These cover workstation and cluster installs, file configuration and how to update cryoSPARC v2 when new versions become available.

  1. Add the following variables bellow the PACKAGES section at ~/.config/scipion/scipion.conf file:

    # The root directory where cryoSPARC code and dependencies will be installed.
    CRYOSPARC_DIR = <install_path>
    
    # full name of the initial admin account to be created
    CRYOSPARC_USER = <user_name>
    
    # path on the worker node to a writable directory residing on the local SSD
    CRYOSSD_DIR = <ssd_path>

To install in development mode

  • Clone or download the plugin repository

git clone https://github.com/scipion-em/scipion-em-cryosparc2.git
  • Install the plugin in developer mode.

scipion installp -p local/path/to/scipion-em-cryosparc2 --devel

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-cryosparc2-1.0.2b0.tar.gz (59.1 kB view details)

Uploaded Source

File details

Details for the file scipion-em-cryosparc2-1.0.2b0.tar.gz.

File metadata

  • Download URL: scipion-em-cryosparc2-1.0.2b0.tar.gz
  • Upload date:
  • Size: 59.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/20.7.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.12

File hashes

Hashes for scipion-em-cryosparc2-1.0.2b0.tar.gz
Algorithm Hash digest
SHA256 0dcb5d91b77b8cd0f2583f19e5f44d00417a34dfb5eff9cca8cb5c95451ebb6f
MD5 301ee9f34c5717b7b96ea105df5887a7
BLAKE2b-256 ef9a16ac4f05eec79a7c6bd810c48c828953f1b59d9a4b3383ed915444e29e12

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page