From 651e6dd25a4fdc62f8c824013df277c5bf7c0bf7 Mon Sep 17 00:00:00 2001 From: Wim Pomp Date: Fri, 30 Oct 2026 19:52:39 +0100 Subject: [PATCH] - fix README --- README.md | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 74411ce..2385e3f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ -# ndbioimage - -[![Pytest](https://github.com/pomppervova/ndbioimage/actions/workflows/pytest.yml/badge.svg)](https://github.com/pomppervova/ndbioimage/actions/workflows/pytest.yml) +[![pytest](https://git.pomppervova.nl/wim/ndbioimage/actions/workflows/pytest.yml/badge.svg)](https://git.pomppervova.nl/wim/ndbioimage/actions?workflow=pytest.yml) +# NDBioImage ## Work in progress -Rust rewrite of python version. Read bio image formats using the bio-formats java package. -[https://www.openmicroscopy.org/bio-formats/](https://www.openmicroscopy.org/bio-formats/) +Rust rewrite of python version. Read bio image formats using some Rust code, the libczi api, and if needed the +bio-formats java package. Exposes (bio) images as a numpy ndarray-like object (Python) or a struct that can be sliced like an ndarray Array (Rust), but without loading the whole image into memory, reading from the file only when needed. Some metadata is read @@ -18,20 +17,6 @@ Currently, it supports imagej tif files, czi files, micromanager tif sequences a To transition to semver, versions before 0.1.0 were yanked from crates.io. -## Installation - -```sh -pip install ndbioimage -``` - -### Installation with option to write mp4 or mkv: - -Work in progress! Make sure ffmpeg is installed. - -```sh -pip install ndbioimage[write] -``` - ## Usage ### Python