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.1.1.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.1.1-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for napari_copick-1.1.1.tar.gz
Algorithm Hash digest
SHA256 19bc3638f666f93acfaf9e87e994cc89ee3e9fb1c934f39f9919be0d1c4703df
MD5 1cc058a4fad96bb11baa8e668cac3198
BLAKE2b-256 af6d46abdaba06ad612a47ff0cacfe5c46077f91726468e04082cfdea69dae6e

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_copick-1.1.1.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.1.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for napari_copick-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 185fb2173e68dcda0f1f4fff74d1ca5d321d5631ad01320caf397e803a69fb6d
MD5 e66612e3ff3e25419cab1a3679b08a6e
BLAKE2b-256 b6d58e6668e9c06ca6a09cf3a44894b2dc4bec32cc39d445b50065cb8c491fbb

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_copick-1.1.1-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