Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update licensing doc #4

Merged
merged 1 commit into from
Sep 6, 2023
Merged

Update licensing doc #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,13 @@ You can install `napari-bfio` via [pip]:

pip install napari-bfio

`napari-bfio` depends on `bfio` package to read/write the data. By default, `bfio` package and the core dependencies (numpy, tifffile, imagecodecs) are installed during the installation process of `napari-bfio`.

Additionally, `bfio` with other dependencies can be installed:

1. `pip install bfio[bioformats]` - Adds support for BioFormats/Java. See [License](#license) for additional information.
2. `pip install bfio[zarr]` - Adds support for OME Zarr
3. `pip install bfio[all]` - Installs all dependencies.

To install latest development version :

Expand All @@ -44,6 +50,11 @@ the coverage at least stays the same before you submit a pull request.
Distributed under the terms of the [MIT] license,
"napari-bfio" is free and open source software

**NOTE**

Bioformats is licensed under GPL, and as a consequence so is the `bioformats_jar`
package. These packages and libraries are installed when using the `bfio[bioformats]` option.

## Issues

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