Skip to main content

Bioformats for napari, using pims

Project description

napari-bioformats

License PyPI Conda Python Version tests codecov

Bioformats plugin for napari using pims-bioformats


Use this plugin as a fallback!

Anyone coming to napari from the Fiji/ImageJ world will likely be aware of the incredible Bio-Formats library. A heroic effort, built over years, to read more than a 100 file formats. Naturally, we want some of that goodness for napari ... hence this plugin.

However: it's important to note that this plugin still requires having a java runtime engine installed. This is easy enough to do (the plugin will ask to install it for you if you're in a conda environment), but it definitely makes for a more complicated environment setup, it's not very "pythonic", and the performance will likely not feel as snappy as a native "pure" python module.

So, before you reflexively install this plugin to fill that bio-formats sized hole in your python heart, consider trying some of the other pure-python plugins designed to read your format of interest:

if you have a pure-python reader for a bio-formats-supported file format that you'd like to see added to this list, please open an issue

Installation

The easiest way to install napari-bioformats is via conda, from the conda-forge channel:

conda install -c conda-forge napari-bioformats

It is also possible to install via pip, but you will need to have a working JVM installed, and may need to set the JAVA_HOME environment variable

pip install napari-bioformats

First Usage

The first time you attempt to open a file with napari-bioformats, you will likely notice a long delay as pims downloads the loci_tools.jar (speed will depend on your internet connection). Subsequent files should open more quickly.

License

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

Issues

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

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

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_bioformats-0.2.1.tar.gz (41.8 MB view details)

Uploaded Source

Built Distribution

napari_bioformats-0.2.1-py3-none-any.whl (41.8 MB view details)

Uploaded Python 3

File details

Details for the file napari_bioformats-0.2.1.tar.gz.

File metadata

  • Download URL: napari_bioformats-0.2.1.tar.gz
  • Upload date:
  • Size: 41.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for napari_bioformats-0.2.1.tar.gz
Algorithm Hash digest
SHA256 16a75cdd6121212153052462098de6501eded880c78773b68e361a1260c4552a
MD5 7659b1d005cf2ec0791fe0cb4be0ef8f
BLAKE2b-256 f6a6cf7c0d6fbd356fdf6c8e7fc991c9cc221043a3f0e76d5c000f74a39048ea

See more details on using hashes here.

File details

Details for the file napari_bioformats-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: napari_bioformats-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 41.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for napari_bioformats-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3bbc0f6f1367f3b93c84baf9293c0233c045496efd7ff0b719f013325f2362ab
MD5 e15b337ee1973289eebca79fd84c5f55
BLAKE2b-256 a4aa4017083519dade1be014ec0d76bac39e2f09760b9d0b045ec1329abfbdf7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page