Skip to content

Commit

Permalink
Update documentation and metadata (#203)
Browse files Browse the repository at this point in the history
* update docs: support OpenCell OME-TIFF

* add badges and python minor versions

* label mantis as supported
  • Loading branch information
ziw-liu authored Nov 13, 2023
1 parent 64090bc commit c0caa45
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 8 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# iohub

[![PyPI - Python version](https://img.shields.io/pypi/pyversions/iohub)](https://pypi.org/project/iohub)
[![PyPI - iohub version](https://img.shields.io/pypi/v/iohub.svg)](https://pypi.org/project/iohub)
[![Docs deployment](https://github.com/czbiohub-sf/iohub/actions/workflows/docs.yml/badge.svg)](https://czbiohub-sf.github.io/iohub)

N-dimensional bioimaging produces data and metadata in various formats,
and iohub aims to become a unified Python interface to the most common formats
used at the Biohub and in the broader imaging community.
Expand All @@ -11,9 +15,8 @@ used at the Biohub and in the broader imaging community.
- OME-Zarr ([OME-NGFF v0.4](https://ngff.openmicroscopy.org/0.4/))
- Micro-Manager TIFF sequence, OME-TIFF (MMStack), and NDTiff datasets
- Custom data formats generated by Biohub microscopes
- Supported: Falcon (PTI), Dorado (ClearControl)
- WIP: Mantis, Dragonfly
- TBA: DaXi
- Supported: Falcon (PTI), Dorado (ClearControl), Dragonfly (OpenCell OME-TIFF), Mantis (NDTiff)
- WIP: DaXi

### Write

Expand All @@ -24,7 +27,13 @@ used at the Biohub and in the broader imaging community.

### Installation

Install iohub with pip:
Install a pre-release of iohub with pip:

```sh
pip install iohub
```

Or install the latest Git version:

```sh
git clone https://github.com/czbiohub-sf/iohub.git
Expand Down
6 changes: 2 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,9 @@ Read

- Custom data formats generated by Biohub microscopes

- Supported: Falcon (PTI), Dorado (ClearControl)
- Supported: Falcon (PTI), Dorado (ClearControl), Dragonfly (OpenCell OME-TIFF), Mantis (NDTiff)

- WIP: Mantis, Dragonfly

- TBA: DaXi
- WIP: DaXi

Write
-----
Expand Down
3 changes: 3 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ classifiers =
Intended Audience :: Science/Research
License :: OSI Approved :: BSD License
Programming Language :: Python :: 3 :: Only
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
Programming Language :: Python :: 3.11
Topic :: Scientific/Engineering
Topic :: Scientific/Engineering :: Image Processing
Operating System :: Microsoft :: Windows
Expand Down

0 comments on commit c0caa45

Please sign in to comment.