From 89a3f1afa6afab4037df907f56f10d3ce541df43 Mon Sep 17 00:00:00 2001 From: Constantin Pape Date: Fri, 29 May 2026 11:53:21 +0200 Subject: [PATCH] Bump version and extend doc --- README.md | 5 +++++ src/bioimage_cpp/__init__.py | 16 +++++++++++++++- src/bioimage_cpp/_version.py | 2 +- 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5e526ce..3dffe9e 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,9 @@ Image processing and segmentation functionality in C++ with light-weight python bindings through nanobind and minimal dependencies to enable distribution via pip. +The `bioimage_cpp` python library can be installed via pip: +```bash +pip install bioimage-cpp +``` + Please refer to [the documentation](https://computational-cell-analytics.github.io/bioimage-cpp/) for details. diff --git a/src/bioimage_cpp/__init__.py b/src/bioimage_cpp/__init__.py index aa9343e..99d963c 100644 --- a/src/bioimage_cpp/__init__.py +++ b/src/bioimage_cpp/__init__.py @@ -17,7 +17,21 @@ ## Installation -TODO: document once on pip / conda +The `bioimage_cpp` library is available on PyPI and can be installed via pip: +```bash +pip install bioimage-cpp +``` + +Additional dependencies for tests / data downloads can be installed via `pip install bioimage-cpp[test]` / `pip install bioimage-cpp[data]` respectively. + +We will make it available on conda-forge as soon as possible. + +You can also install this library from source as follows: +``` +git clone https://github.com/computational-cell-analytics/bioimage-cpp +cd bioimage-cpp +pip install -e . +``` ## Functionality diff --git a/src/bioimage_cpp/_version.py b/src/bioimage_cpp/_version.py index 485f44a..d3ec452 100644 --- a/src/bioimage_cpp/_version.py +++ b/src/bioimage_cpp/_version.py @@ -1 +1 @@ -__version__ = "0.1.1" +__version__ = "0.2.0"