Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
16 changes: 15 additions & 1 deletion src/bioimage_cpp/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/bioimage_cpp/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.1.1"
__version__ = "0.2.0"
Loading