Skip to content

Commit 89332af

Browse files
committed
modified readme
1 parent fdd2c1b commit 89332af

File tree

2 files changed

+29
-18
lines changed

2 files changed

+29
-18
lines changed

README.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,44 @@ This repository provides a collection of tools to simplify reading CZI (Carl Zei
1111

1212
## Installation
1313

14-
To install czitools use (will not install Napari or plotting functionality):
14+
To install czitools (core functionality) use:
1515

1616
```text
1717
pip install czitools
1818
```
1919

20-
To install the package with all optional dependencies use (will not install Napari):
20+
To install the package with all optional dependencies use::
2121

2222
```text
2323
pip install czitools[all]
2424
```
2525

26+
### Local Installation
27+
28+
Local installation for developing etc.:
29+
30+
```text
31+
pip install -e .
32+
```
33+
34+
Local installation (full functionality):
35+
36+
```text
37+
pip install -e ".[all]"
38+
```
39+
40+
### Supported Operating Systems
41+
42+
Currently this only works on:
43+
44+
* Linux
45+
* Windows
46+
47+
MacOS is not supported yet out of the box, but if one installs pylibCZIrw wheels for MacOS manually the package should work (not tested).
48+
49+
Thanks to the community for providing [MaxOS wheels for pylibCZIrw](https://pypi.scm.io/#/package/pylibczirw) wheels for MacOS, which makes it possible to read and write CZI files on MacOS.
50+
51+
2652
## Reading the metadata
2753

2854
Please check [use_metadata_tools.py](https://github.com/sebi06/czitools/blob/main/demo/scripts/use_metadata_tools.py) for some examples.
@@ -181,17 +207,3 @@ The basic usage can be inferred from this sample notebook: 
181207
## Remarks
182208

183209
The code to read multi-dimensional with delayed reading using Dask array was heavily inspired by input from: [Pradeep Rajasekhar](https://github.com/pr4deepr).
184-
185-
### Local Installation
186-
187-
Local installation:
188-
189-
```text
190-
pip install -e .
191-
```
192-
193-
Local installation (full functionality):
194-
195-
```text
196-
pip install -e ".[all]"
197-
```

setup.cfg

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author = Sebastian Rhode
55
author_email = sebrhode@gmail.com
66
url = https://github.com/sebi06/czitools
77
license = GNU General Public License v3 (GPLv3)
8-
description = Tools to simplify reading CZI (Carl Zeiss Image) meta and pixel data
8+
description = Tools to simplify reading and CZI (Carl Zeiss Image) meta and pixel data
99
long_description = file: README.md
1010
long_description_content_type = text/markdown
1111

@@ -53,7 +53,6 @@ install_requires =
5353

5454
[options.extras_require]
5555
all =
56-
magicgui
5756
seaborn
5857
plotly
5958
qtpy

0 commit comments

Comments
 (0)