Skip to main content

Napari plugin for viewing Brain Image Library datasets

Project description

Description

View datasets archived at the Brain Image Library.

**NOTE: This plugin is under early development. Currently, only a subset of single-channel, fMOST datasets which include projections are available to view. An example can be found here.

Plugin Demo GIF

Features

  • Multiscale Rendering
    • In datasets that include multiple resolution representations of the data, each resolution can be combined to improve the speed of browsing and user experience. An example of a dataset with multiple resolution projections can be found here.
    • All datasets included in the current release of napari-bil-data-viewer use multi-resolution datasets.
  • 3D rendering of whole datasets. The lowest resolution is used for rendering. Currently, this is a limitation imposed by napari.
  • The plugin does NOT require a BIL account as datasets are already accessible via https.

Known Issues / limitations

  • Currently the only datasets that are available are those which have been manually selected by the developers. If you would like a specific dataset to be included please consider adding the dataset(s) to the dataset_info.py file and submitting a pull request.
  • To inquire about this plugin please contact Brain Image Library support: bil-support@psc.edu
  • The plugin is still under development. We appreciate all reports of issues / errors which occur during use.

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

Installation

Option #1: Install plugin via the napari plugin menu

  1. Menu: Plugins >> Install/Uninstall Plugins
  2. Search: napari-bil-data-viewer
  3. Select install

Option #2: Install a fresh python virtual environment

# Example of venv creation using conda
conda create -y -n bil-viewer python=3.8
conda activate bil-viewer

# Install napari-bil-data-viewer
pip install napari-bil-data-viewer

# Run Napari
napari

Contributing

Please consider contributing to this project! 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 BSD-3 license, "napari-bil-data-viewer" is free and open source software

Issues

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

Change Log:

v0.1.0:

Initial release.

v0.1.1 & v0.1.2:

Changes to documentation

v0.1.3:

Added all available summary fMOST datasets

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-bil-data-viewer-0.1.3.tar.gz (33.7 MB view details)

Uploaded Source

Built Distribution

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

napari_bil_data_viewer-0.1.3-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file napari-bil-data-viewer-0.1.3.tar.gz.

File metadata

  • Download URL: napari-bil-data-viewer-0.1.3.tar.gz
  • Upload date:
  • Size: 33.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for napari-bil-data-viewer-0.1.3.tar.gz
Algorithm Hash digest
SHA256 681d63872f81ce4e79100e3ceb1405d8125d847bbf0cefafb643be2bc8b48f67
MD5 ba705f825779a61659bb177503562294
BLAKE2b-256 46aeca70fe62fd7a5f1bb0b350edf7ffca00c7acfbe2e3bda4a1334385bc0c67

See more details on using hashes here.

File details

Details for the file napari_bil_data_viewer-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_bil_data_viewer-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7c09523558881a550339495498a36b3c575f9f0d06ff98b3baddbca62333fa41
MD5 73eb4b4c3b5cf2e19882d85db77fb8a7
BLAKE2b-256 75c7a1282b24a7b39d6aaede069779175b60e72697b282ec9263af7e5632dfd8

See more details on using hashes here.

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