Skip to content

Commit c4e7850

Browse files
committed
Add badges and installation docs for conda-forge and soruce builds
1 parent 539e80b commit c4e7850

2 files changed

Lines changed: 28 additions & 3 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
# bioimage-cpp
22

3+
[![PyPI](https://img.shields.io/pypi/v/bioimage-cpp)](https://pypi.org/project/bioimage-cpp/)
4+
[![conda-forge](https://img.shields.io/conda/vn/conda-forge/bioimage-cpp)](https://anaconda.org/conda-forge/bioimage-cpp)
5+
[![Documentation](https://img.shields.io/badge/docs-pdoc-blue)](https://computational-cell-analytics.github.io/bioimage-cpp/)
6+
37
Image processing and segmentation functionality in C++ with light-weight python bindings through nanobind and minimal dependencies to enable distribution via pip.
48

59
The `bioimage_cpp` python library can be installed via pip:
610
```bash
711
pip install bioimage-cpp
812
```
913

14+
Or via conda-forge:
15+
```bash
16+
conda install -c conda-forge bioimage-cpp
17+
```
18+
1019
Please refer to [the documentation](https://computational-cell-analytics.github.io/bioimage-cpp/) for details.

src/bioimage_cpp/__init__.py

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,33 @@
2222
pip install bioimage-cpp
2323
```
2424
25+
Or via conda-forge:
26+
```bash
27+
conda install -c conda-forge bioimage-cpp
28+
```
29+
2530
Additional dependencies for tests / data downloads can be installed via `pip install bioimage-cpp[test]` / `pip install bioimage-cpp[data]` respectively.
2631
27-
We will make it available on conda-forge as soon as possible.
32+
You can also install this library from source. The build requires C++20 (GCC >= 10 or Clang >= 13).
2833
29-
You can also install this library from source as follows:
30-
```
34+
If your system already has a C++20-capable compiler, clone and build directly:
35+
```bash
3136
git clone https://github.com/computational-cell-analytics/bioimage-cpp
3237
cd bioimage-cpp
3338
pip install -e .
3439
```
3540
41+
On systems with an older compiler (e.g. many HPC clusters ship GCC 8), install a modern one from conda-forge alongside the build dependencies, and point `CC`/`CXX` at it:
42+
```bash
43+
conda install gcc_linux-64 gxx_linux-64 scikit-build-core nanobind -c conda-forge -y
44+
export CC=x86_64-conda-linux-gnu-gcc
45+
export CXX=x86_64-conda-linux-gnu-g++
46+
pip install --no-build-isolation -e .
47+
```
48+
49+
The `--no-build-isolation` flag reuses the `scikit-build-core` and `nanobind` already installed in your environment.
50+
Re-run the same command after any C++ source change to rebuild.
51+
3652
## Functionality
3753
3854
This library provides the following functionality:

0 commit comments

Comments
 (0)