Skip to content

Commit 14d1acf

Browse files
Bump version and extend doc (#51)
1 parent 5b5f009 commit 14d1acf

3 files changed

Lines changed: 21 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,9 @@
22

33
Image processing and segmentation functionality in C++ with light-weight python bindings through nanobind and minimal dependencies to enable distribution via pip.
44

5+
The `bioimage_cpp` python library can be installed via pip:
6+
```bash
7+
pip install bioimage-cpp
8+
```
9+
510
Please refer to [the documentation](https://computational-cell-analytics.github.io/bioimage-cpp/) for details.

src/bioimage_cpp/__init__.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,21 @@
1717
1818
## Installation
1919
20-
TODO: document once on pip / conda
20+
The `bioimage_cpp` library is available on PyPI and can be installed via pip:
21+
```bash
22+
pip install bioimage-cpp
23+
```
24+
25+
Additional dependencies for tests / data downloads can be installed via `pip install bioimage-cpp[test]` / `pip install bioimage-cpp[data]` respectively.
26+
27+
We will make it available on conda-forge as soon as possible.
28+
29+
You can also install this library from source as follows:
30+
```
31+
git clone https://github.com/computational-cell-analytics/bioimage-cpp
32+
cd bioimage-cpp
33+
pip install -e .
34+
```
2135
2236
## Functionality
2337

src/bioimage_cpp/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.1.1"
1+
__version__ = "0.2.0"

0 commit comments

Comments
 (0)