Metadata-Version: 2.1
Name: napari-bil-data-viewer
Version: 0.1.1
Summary: Napari plugin for viewing Brain Image Library datasets
Home-page: https://github.com/brain-image-library/napari-bil-data-viewer
Author: Alan M Watson
Author-email: alan.watson@pitt.edu
License: BSD-3-Clause
Project-URL: Bug Tracker, https://github.com/brain-image-library/napari-bil-data-viewer/issues
Project-URL: Documentation, https://github.com/brain-image-library/napari-bil-data-viewer#README.md
Project-URL: Source Code, https://github.com/brain-image-library/napari-bil-data-viewer
Project-URL: User Support, https://github.com/brain-image-library/napari-bil-data-viewer
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Framework :: napari
Classifier: Topic :: Software Development :: Testing
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE



# Description

This plugin enables viewing of datasets archived in the Brain Image Library.  

**https://www.brainimagelibrary.org/**



**NOTE: This plugin is under early development.  Currently, only a subset of single color, fMOST datasets which include projections are available to view.  An example can be found here:  https://download.brainimagelibrary.org/2b/da/2bdaf9e66a246844/mouseID_405429-182725/



![Plugin Demo](https://imgur.com/gkDCsMd.gif "Plugin Demo")



### Features

* Multiscale Rendering
  * Datasets which include multiple resolution representations of the data can be used for 
  https://download.brainimagelibrary.org/2b/da/2bdaf9e66a246844/mouseID_405429-182725/
* 3D rendering of whole datasets.  The lowest resolution will be used for rendering.
* 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:  https://github.com/brain-image-library/napari-bil-data-viewer/blob/main/napari_bil_data_viewer/dataset_info.py
* The plugin is still under development.  We appreciate all reports of errors which occur during use.  https://github.com/brain-image-library/napari-bil-data-viewer/issues


----------------------------------

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

<!--
Don't miss the full getting started guide to set up your new package:
https://github.com/napari/cookiecutter-napari-plugin#getting-started

and review the napari docs for plugin developers:
https://napari.org/docs/plugins/index.html
-->

## 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

## Change Log:

##### <u>v0.1.0:</u>

Initial release.

## 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.

[napari]: https://github.com/napari/napari
[Cookiecutter]: https://github.com/audreyr/cookiecutter
[@napari]: https://github.com/napari
[MIT]: http://opensource.org/licenses/MIT
[BSD-3]: http://opensource.org/licenses/BSD-3-Clause
[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0
[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin

[file an issue]: https://github.com/brain-image-library/napari-bil-data-viewer/issues

[napari]: https://github.com/napari/napari
[tox]: https://tox.readthedocs.io/en/latest/
[pip]: https://pypi.org/project/pip/
[PyPI]: https://pypi.org/

