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.2.tar.gz (74.2 kB view details)

Uploaded Source

Built Distribution

blik-0.9.2-py3-none-any.whl (31.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: blik-0.9.2.tar.gz
  • Upload date:
  • Size: 74.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for blik-0.9.2.tar.gz
Algorithm Hash digest
SHA256 de4a2355b0dae06e8e19a527f302a7f9c30424c5bb9fea81619a17bcb2015c60
MD5 198c5bd84a2f3c4e70ed465b73dfc7ff
BLAKE2b-256 2c8472e634b023a3f1fb8c9f5a7de54264e51a57a915df76856a2f8d02c37f80

See more details on using hashes here.

File details

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

File metadata

  • Download URL: blik-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 31.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for blik-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c982bceef6fd544c68dfd1d977a980d41ee080d23caf24be43cf1049b67e2d80
MD5 49aad720381c47b0a82275ce081a2e29
BLAKE2b-256 ff03cbebeaacbd7a4845c4b0e67fba850c892859f47f16ef9adcbf87c0ea6da9

See more details on using hashes here.

Supported by

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