Skip to content

Commit 53a4bed

Browse files
Update test matrix and doc
1 parent 4286e50 commit 53a4bed

2 files changed

Lines changed: 24 additions & 2 deletions

File tree

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
strategy:
1212
fail-fast: false
1313
matrix:
14-
os: [ubuntu-latest, macos-13, macos-14, windows-latest]
14+
os: [ubuntu-latest, macos-latest, windows-latest]
1515
steps:
1616
- uses: actions/checkout@v4
1717
- uses: actions/setup-python@v5

src/bioimage_cpp/__init__.py

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,26 @@
1-
"""Dependency-light bioimage analysis algorithms backed by C++."""
1+
"""`bioimage_cpp` implements functionality needed for image procesing in C++.
2+
It generates light-weight python bindings with nanobind with minimal dependencies to enable distribution via pip.
3+
4+
The main goal of this library is to provide functionality that is missing from scipy or scikit-image or
5+
to provide more performant versions of functionality from these libraries.
6+
7+
The functionality implemented here bundles and improves algorithms etc. from:
8+
- [affogato](https://github.com/constantinpape/affogato)
9+
- [fastfilters](https://github.com/sciai-lab/fastfilters)
10+
- [nifty](https://github.com/DerThorsten/nifty)
11+
- [vigra](https://github.com/ukoethe/vigra)
12+
13+
The goal is to provide the functionality within a single library and via pip as well as conda.
14+
15+
**Warning:** This library was written mainly by coding agents (claude code and openai codex).
16+
It is not very thoroughly tested and may contain bugs.
17+
18+
## Installation
19+
20+
TODO: document once on pip / conda
21+
22+
.. include:: ../../MIGRATION_GUIDE.md
23+
"""
224

325
from ._version import __version__
426
from . import affinities

0 commit comments

Comments
 (0)