Skip to main content

A simple utility to convert cryosparc particle positions to relion star format.

Project description

cs2star

License PyPI Python Version CI codecov

A simple utility that wraps around csparc2star.py to convert particle positions from Cryosparc JOB directories into a RELION-ready directory. On top of what csparc2star.py already does, this script will traverse the Cryosparc job tree to find the relevant .cs files, automatically symlinks (or copies) the .mrc files (renaming them as appropriate to mrcs and updating the rlnMicrographName column to reflect the change). cs2star also separates micrograph information in a micrographs.star file, which is required in several relion jobs.

Installation

This package requires pyem, which is not available on pip under that name (there is a pyem on pip; that's a different package!). To install it manually [NOTE: some fixes necessary for this are not yet on the main repo, so we're installing from a fork]:

pip install git+https://github.com/brisvag/pyem.git

You can then install cs2star with pip:

pip install cs2star

Usage

cs2star cryosparc_job_dir [dest_dir]

A couple more options are available, check out the help page with -h.

Example

Assuming Cryosparc/J23 is a classification job:

cs2star Cryosparc/J23 -p

will create in the working directory:

  • a relion-ready particles.star
  • a relion-ready micrographs.star
  • a patches directory containing the particle images to be used by relion refinement You can now run relion and provide particles.star and micrographs.star as the inputs.

Tips

  • While you can use the --class option to select specific classes from a cryosparc job, the class indexes do not correspond the the class order in Cryosparc (which is simply based on particle number). A much easier way to select specific classes to convert to .star is to use the select 2D classes job in cryosparc, then provide this job as input to cs2star.
  • --swapxy defaults to True. This is because usually that's what you need; unfortunately, this may differ on a case by case basis, so make sure to check the data after conversion with you favourite viewer to ensure that particles are correctly centered.

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

cs2star-0.7.0.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

cs2star-0.7.0-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

Details for the file cs2star-0.7.0.tar.gz.

File metadata

  • Download URL: cs2star-0.7.0.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for cs2star-0.7.0.tar.gz
Algorithm Hash digest
SHA256 c5cd1271eaf563e53403bf4645c99012a83d2cd13df6b6e4bc1766a0f3c0f57e
MD5 8db8b4387b0aaa7c6faaca275f9acb79
BLAKE2b-256 2aed505e23e3a42bc6bc21c2f2cc2808e5c8289f1fb25f32bc14fcff90a04a0c

See more details on using hashes here.

File details

Details for the file cs2star-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: cs2star-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 20.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for cs2star-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 091fd6ca3f85f3f6f34ff21be47d459a015efd456d6b99d15208bbb289bc9a02
MD5 36c03e9900d3b1117fb133dcc7031a41
BLAKE2b-256 2ed85625a8a14944361b751109e53b57cd77503c0d628cde6d663496d43b8d6d

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