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.
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
- Menu: Plugins >> Install/Uninstall Plugins
- Search: napari-bil-data-viewer
- 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
v0.2.0:
Added support for SWC neuron tracings
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for napari-bil-data-viewer-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 193eaa5a74c5548022131553506163a897caef87901df3f39dcbf6069fcac782 |
|
MD5 | 86582a370bdcb21b85479d07a1f8fc9a |
|
BLAKE2b-256 | 3dc7576dc2e89e6147f5e9004ac333e907a18e0f49a4ce1c4c06ae36c38b5ceb |
Hashes for napari_bil_data_viewer-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d858be78ce618351500c21bed60b66251429a24d2dd3797f703095b6b6b7fc2 |
|
MD5 | 4b90f39fb023c8b75bc2d748695bbc09 |
|
BLAKE2b-256 | 177b5a4e2687835f6de3a68192f59ed7b111aabf3d539c2213ac0460da82fa40 |