Skip to main content

A plugin for collaborative annotation in cryoET using copick

Project description

napari-copick

License MIT PyPI Python Version tests codecov napari hub

A plugin for collaborative annotation in cryoET using copick

interface.png


This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.

Installation

You can install napari-copick via pip:

pip install napari-copick

To install latest development version:

pip install git+https://github.com/copick/napari-copick.git

Usage

Using a copick config file

napari-copick run --config path/to/copick_config.json

Using dataset IDs from CZ cryoET Data Portal

napari-copick run --dataset-ids 10440 10441 --overlay-root /path/to/overlay_root

You can specify multiple dataset IDs separated by spaces.

GUI Usage

The plugin provides an intuitive interface with two loading options:

  1. Load Config File: Opens a file dialog to select a copick configuration JSON file
  2. Load from Dataset IDs: Opens a dialog to enter CZ cryoET Data Portal dataset IDs and overlay root path

After loading, you'll see a hierarchical tree of the project structure that you can navigate to access tomograms, segmentations, and picks.

Tomogram Handling

napari-copick now handles multiscale zarr arrays directly:

  • Automatically detects and loads all available resolution levels
  • Creates a proper multiscale image stack using napari's native multiscale API
  • Uses dask for efficient lazy loading of large tomogram data
  • Applies appropriate scaling factors based on the voxel size metadata

This direct zarr handling provides better performance and more flexibility compared to relying on external plugins.

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the MIT license, "napari-copick" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to opensource@chanzuckerberg.com.

Reporting Security Issues

If you believe you have found a security issue, please responsibly disclose by contacting us at security@chanzuckerberg.com.

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

napari_copick-1.9.0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

napari_copick-1.9.0-py3-none-any.whl (42.9 kB view details)

Uploaded Python 3

File details

Details for the file napari_copick-1.9.0.tar.gz.

File metadata

  • Download URL: napari_copick-1.9.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for napari_copick-1.9.0.tar.gz
Algorithm Hash digest
SHA256 c3ed9c661f44c809459914a34b9305df4a66895bae2808be0b8632e7498c7333
MD5 4cea461d85eb6676ef1307b2000463cb
BLAKE2b-256 2ffd1b2cfa716b7a3ca99171f15cf9a4f07faa9387aa5f27bf5cc4b8e1e128da

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_copick-1.9.0.tar.gz:

Publisher: release-please.yml on copick/napari-copick

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file napari_copick-1.9.0-py3-none-any.whl.

File metadata

  • Download URL: napari_copick-1.9.0-py3-none-any.whl
  • Upload date:
  • Size: 42.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for napari_copick-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c268b8a3b11388efd53f9de691ef2fafd91e0188ea0f26cb2f135cf0fe13335f
MD5 011a8e07aecba44f63479a7f036203f9
BLAKE2b-256 10dd8099e3d6fe5cbbb14d1126eff0fed4d99e007337aa66f86f6a974bc71b15

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_copick-1.9.0-py3-none-any.whl:

Publisher: release-please.yml on copick/napari-copick

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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