Skip to main content

Python tool for visualising and interacting with cryo-ET and subtomogram averaging data.

Project description

logo

blik

DOI Paper DOI License PyPI Python Version CI codecov

blik showcase

blik is a tool for visualising and interacting with cryo-ET and subtomogram averaging data. It leverages the fast, multi-dimensional napari viewer and the scientific python stack.

DISCLAIMER: this package is in development phase. Expect bugs and crashes. Please, report them on the issue tracker and ask if anything is unclear!

Installation

You can either install blik through the napari plugin system, through pip, or get both napari and blik directly with:

pip install "blik[all]"

The [all] qualifier also installs pyqt5 as the napari GUI backend, and a few additional napari plugins that you might find useful in your workflow:

Nightly build

If you'd like the most up to date blik possible, you can install directly from the main branch on github. This also uses napari main, so expect some instability!

pip install "git+https://github.com/brisvag/blik.git@main#egg=blik[all]"
pip install "git+https://github.com/napari/napari.git@main#egg=napari[all]"

Basic Usage

From the command line:

napari -w blik -- /path/to.star /path/to/mrc/files/*

The -w blik is important for proper initialization of all the layers. Always open the main widget open to ensure nothing goes wrong!

blik is just napari. Particles and images are exposed as simple napari layers, which can be analysed and manipulated with simple python, and most importantly other napari plugins.

Widgets

The main widget has a few functions:

  • experiment: quickly switch to a different experiment id (typically, everything related to an individual tomogram such as volume, particles and segmentations)
  • new: generate a new segmentation, a new manually-picked set of particles, or a new surface, sphere, or filament picking for segmentation, particle generation or volume resampling.
  • add to exp: add a layer to the currently selected experiment (just a shorthand for layer.metadata['experiment_id'] = current_exp_id)
  • slice_thickness: changes the slicing thickness in all dimensions in napari. Images will be averaged over that thickness, and all particles in the slice will be displayed.

There are also widgets for picking surfaces, spheres and filaments:

  • surface: process a previously picked surface picking layer to generate a surface mesh and distribute particles on it for subtomogram averaging, or resample a tomogram along the surface.
  • sphere: process a previously picked sphere picking layer to generate a sphere mesh and distribute particles on it for subtomogram averaging.
  • filament: process a previously picked filament picking layer to generate a filament and distribute particles on it for subtomogram averaging, or resample a tomogram along the filament.

References

If you use blik, please cite the repo on zenodo and the paper on Plos Biology: https://doi.org/10.1371/journal.pbio.3002447.

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

blik-0.9.1.tar.gz (73.6 kB view details)

Uploaded Source

Built Distribution

blik-0.9.1-py3-none-any.whl (30.9 kB view details)

Uploaded Python 3

File details

Details for the file blik-0.9.1.tar.gz.

File metadata

  • Download URL: blik-0.9.1.tar.gz
  • Upload date:
  • Size: 73.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for blik-0.9.1.tar.gz
Algorithm Hash digest
SHA256 be78b19a50d8febc9dea858a681171390bf60b186694c4b1fbac2b18d4dbebd8
MD5 5740989f4ffbb6a9630dd282acd64a43
BLAKE2b-256 dc022e16bbf1fcdac54aef8be12e19d5ea342119221e55c32a4ff6be1e6d8bbc

See more details on using hashes here.

File details

Details for the file blik-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: blik-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 30.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for blik-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d71347f4fc9f0b95b0a6a87bea94a735abcba1c2776cb1bb095b5785959f761c
MD5 e4d489c51aabd4837028c430e0532bfa
BLAKE2b-256 6a2d9a62b6bb026882c99ef761d2662f85e4b649e42ca7c6aa4851ff1ca06c89

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