You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-16Lines changed: 28 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,18 +11,44 @@ This repository provides a collection of tools to simplify reading CZI (Carl Zei
11
11
12
12
## Installation
13
13
14
-
To install czitools use (will not install Napari or plotting functionality):
14
+
To install czitools (core functionality) use:
15
15
16
16
```text
17
17
pip install czitools
18
18
```
19
19
20
-
To install the package with all optional dependencies use (will not install Napari):
20
+
To install the package with all optional dependencies use::
21
21
22
22
```text
23
23
pip install czitools[all]
24
24
```
25
25
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
+
26
52
## Reading the metadata
27
53
28
54
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:
181
207
## Remarks
182
208
183
209
The code to read multi-dimensional with delayed reading using Dask array was heavily inspired by input from: [Pradeep Rajasekhar](https://github.com/pr4deepr).
0 commit comments