ome-arrow 0.0.2__py3-none-any.whl → 0.0.3__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ome_arrow/_version.py +2 -2
- ome_arrow-0.0.3.dist-info/METADATA +111 -0
- {ome_arrow-0.0.2.dist-info → ome_arrow-0.0.3.dist-info}/RECORD +6 -6
- ome_arrow-0.0.2.dist-info/METADATA +0 -34
- {ome_arrow-0.0.2.dist-info → ome_arrow-0.0.3.dist-info}/WHEEL +0 -0
- {ome_arrow-0.0.2.dist-info → ome_arrow-0.0.3.dist-info}/licenses/LICENSE +0 -0
- {ome_arrow-0.0.2.dist-info → ome_arrow-0.0.3.dist-info}/top_level.txt +0 -0
ome_arrow/_version.py
CHANGED
|
@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
|
|
|
28
28
|
commit_id: COMMIT_ID
|
|
29
29
|
__commit_id__: COMMIT_ID
|
|
30
30
|
|
|
31
|
-
__version__ = version = '0.0.
|
|
32
|
-
__version_tuple__ = version_tuple = (0, 0,
|
|
31
|
+
__version__ = version = '0.0.3'
|
|
32
|
+
__version_tuple__ = version_tuple = (0, 0, 3)
|
|
33
33
|
|
|
34
34
|
__commit_id__ = commit_id = None
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ome-arrow
|
|
3
|
+
Version: 0.0.3
|
|
4
|
+
Summary: Using OME specifications with Apache Arrow for fast, queryable, and language agnostic bioimage data.
|
|
5
|
+
Author: Dave Bunten
|
|
6
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
7
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
8
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
9
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
11
|
+
Requires-Python: >=3.11
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
Requires-Dist: bioio>=3
|
|
15
|
+
Requires-Dist: bioio-ome-tiff>=1.4
|
|
16
|
+
Requires-Dist: bioio-ome-zarr>=3.0.3
|
|
17
|
+
Requires-Dist: bioio-tifffile>=1.3
|
|
18
|
+
Requires-Dist: fire>=0.7
|
|
19
|
+
Requires-Dist: ipywidgets>=8.1.8
|
|
20
|
+
Requires-Dist: jupyterlab-widgets>=3.0.16
|
|
21
|
+
Requires-Dist: matplotlib>=3.10.7
|
|
22
|
+
Requires-Dist: numpy>=2.2.6
|
|
23
|
+
Requires-Dist: pandas>=2.2.3
|
|
24
|
+
Requires-Dist: pillow>=12
|
|
25
|
+
Requires-Dist: pyarrow>=22
|
|
26
|
+
Requires-Dist: pyvista>=0.46.4
|
|
27
|
+
Requires-Dist: trame>=3.12
|
|
28
|
+
Requires-Dist: trame-vtk>=2.10
|
|
29
|
+
Requires-Dist: trame-vuetify>=3.1
|
|
30
|
+
Dynamic: license-file
|
|
31
|
+
|
|
32
|
+
<img height="200" src="https://raw.githubusercontent.com/wayscience/ome-arrow/main/docs/src/_static/logo.png?raw=true">
|
|
33
|
+
|
|
34
|
+

|
|
35
|
+
[](https://github.com/wayscience/ome-arrow/actions/workflows/run-tests.yml?query=branch%3Amain)
|
|
36
|
+
[](https://github.com/astral-sh/ruff)
|
|
37
|
+
[](https://github.com/astral-sh/uv)
|
|
38
|
+
|
|
39
|
+
# Open, interoperable, and queryable microscopy images with OME Arrow
|
|
40
|
+
|
|
41
|
+
OME-Arrow uses [Open Microscopy Environment (OME)](https://github.com/ome) specifications through [Apache Arrow](https://arrow.apache.org/) for fast, queryable, and language agnostic bioimage data.
|
|
42
|
+
|
|
43
|
+
<img height="200" src="https://raw.githubusercontent.com/wayscience/ome-arrow/main/docs/src/_static/references_to_files.png">
|
|
44
|
+
|
|
45
|
+
__Images are often left behind from the data model, referenced but excluded from databases.__
|
|
46
|
+
|
|
47
|
+
<img height="200" src="https://raw.githubusercontent.com/wayscience/ome-arrow/main/docs/src/_static/various_ome_arrow_schema.png">
|
|
48
|
+
|
|
49
|
+
__OME-Arrow brings images back into the story.__
|
|
50
|
+
|
|
51
|
+
OME Arrow enables image data to be stored alongside metadata or derived data such as single-cell morphology features.
|
|
52
|
+
Images in OME Arrow are composed of mutlilayer [structs](https://arrow.apache.org/docs/python/generated/pyarrow.struct.html) so they may be stored as values within tables.
|
|
53
|
+
This means you can store, query, and build relationships on data from the same location using any system which is compatible with Apache Arrow (including Parquet) through common data interfaces (such as SQL and DuckDB).
|
|
54
|
+
|
|
55
|
+
## Installation
|
|
56
|
+
|
|
57
|
+
Install OME Arrow from PyPI or from source:
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
# install from pypi
|
|
61
|
+
pip install ome-arrow
|
|
62
|
+
|
|
63
|
+
# install directly from source
|
|
64
|
+
pip install git+https://github.com/wayscience/ome-arrow.git
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Quick start
|
|
68
|
+
|
|
69
|
+
See below for a quick start guide.
|
|
70
|
+
Please also reference an example notebook: [Learning to fly with OME-Arrow](https://github.com/wayscience/ome-arrow/tree/main/docs/src/examples/learning_to_fly_with_ome-arrow.ipynb).
|
|
71
|
+
|
|
72
|
+
```python
|
|
73
|
+
from ome_arrow import OMEArrow
|
|
74
|
+
|
|
75
|
+
# Ingest a tif image through a convenient OME Arrow class
|
|
76
|
+
# We can also ingest OME-Zarr or NumPy arrays.
|
|
77
|
+
oa_image = OMEArrow(
|
|
78
|
+
data="your_image.tif"
|
|
79
|
+
)
|
|
80
|
+
|
|
81
|
+
# Access the OME Arrow struct itself
|
|
82
|
+
# (compatible with Arrow-compliant data storage).
|
|
83
|
+
oa_image.data
|
|
84
|
+
|
|
85
|
+
# Show information about the image.
|
|
86
|
+
oa_image.info()
|
|
87
|
+
|
|
88
|
+
# Display the image with matplotlib.
|
|
89
|
+
oa_image.view(how="matplotlib")
|
|
90
|
+
|
|
91
|
+
# Display the image with pyvista
|
|
92
|
+
# (great for ZYX 3D images).
|
|
93
|
+
oa_image.view(how="pyvista")
|
|
94
|
+
|
|
95
|
+
# Export to OME-Parquet.
|
|
96
|
+
# We can also export OME-TIFF, OME-Zarr or NumPy arrays.
|
|
97
|
+
oa_image.export(how="ome-parquet", out="your_image.ome.parquet")
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Contributing, Development, and Testing
|
|
101
|
+
|
|
102
|
+
Please see our [contributing documentation](https://github.com/wayscience/ome-arrow/tree/main/CONTRIBUTING.md) for more details on contributions, development, and testing.
|
|
103
|
+
|
|
104
|
+
## Related projects
|
|
105
|
+
|
|
106
|
+
OME Arrow is used or inspired by the following projects, check them out!
|
|
107
|
+
|
|
108
|
+
- [`napari-ome-arrow`](https://github.com/WayScience/napari-ome-arrow): enables you to view OME Arrow and related images.
|
|
109
|
+
- [`nViz`](https://github.com/WayScience/nViz): focuses on ingesting and visualizing various 3D image data.
|
|
110
|
+
- [`CytoDataFrame`](https://github.com/cytomining/CytoDataFrame): provides a DataFrame-like experience for viewing feature and microscopy image data within Jupyter notebook interfaces.
|
|
111
|
+
- [`coSMicQC`](https://github.com/cytomining/coSMicQC): performs quality control on microscopy feature datasets, visualized using CytoDataFrames.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
ome_arrow/__init__.py,sha256=DfQsw8l0mx1Qt3YiiMv2SUljKETP3wS5hrD5eBbjMDM,583
|
|
2
|
-
ome_arrow/_version.py,sha256=
|
|
2
|
+
ome_arrow/_version.py,sha256=pBZsQt6tlL02W-ri--X_4JCubpAK7jjCSnOmUp_isjc,704
|
|
3
3
|
ome_arrow/core.py,sha256=NUCV9KUH3yCOlpetRS5NNVG_phodutE1F2ujDBPhHgY,18351
|
|
4
4
|
ome_arrow/export.py,sha256=CCTnEdHko4Z0i5LEHuNGFLznWSsPyAFcS42H5nHU22Q,14875
|
|
5
5
|
ome_arrow/ingest.py,sha256=zZz94LaLOpmoxnryLeoPsaWV0EzkYkGFizYSVcbd5w8,33016
|
|
@@ -7,8 +7,8 @@ ome_arrow/meta.py,sha256=qeD0e_ItAQyZDT7ypkBU0rBh9oHIu2ziz9MCfPpPp9g,4199
|
|
|
7
7
|
ome_arrow/transform.py,sha256=0275_Mn1mlGXSWJ86llch8JoJyvqEOfvG-ub1dUWFNI,5997
|
|
8
8
|
ome_arrow/utils.py,sha256=XHovcqmjqoiBpKvXY47-_yUwf07f8zVE_F9BR_VKaPU,2383
|
|
9
9
|
ome_arrow/view.py,sha256=DT8i56uV8Rw22KkqwjPPPKWJWNtfgR9OkI8Qj1WD8Ds,9355
|
|
10
|
-
ome_arrow-0.0.
|
|
11
|
-
ome_arrow-0.0.
|
|
12
|
-
ome_arrow-0.0.
|
|
13
|
-
ome_arrow-0.0.
|
|
14
|
-
ome_arrow-0.0.
|
|
10
|
+
ome_arrow-0.0.3.dist-info/licenses/LICENSE,sha256=9-2Pyhu3vTt2RJU8DorHQtHeNO_e5RLeFJTyOU4hOi4,1508
|
|
11
|
+
ome_arrow-0.0.3.dist-info/METADATA,sha256=VrhOZ3ENlUTdd3smTk_pCN8ptbuZJbhDwuCxdLu8UDc,4910
|
|
12
|
+
ome_arrow-0.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
13
|
+
ome_arrow-0.0.3.dist-info/top_level.txt,sha256=aWOtkGXo_pfU-yy82guzGhz8Zh2h2nFl8Kc5qdzMGuE,10
|
|
14
|
+
ome_arrow-0.0.3.dist-info/RECORD,,
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: ome-arrow
|
|
3
|
-
Version: 0.0.2
|
|
4
|
-
Summary: Using OME specifications with Apache Arrow for fast, queryable, and language agnostic bioimage data.
|
|
5
|
-
Author: Dave Bunten
|
|
6
|
-
Classifier: Programming Language :: Python :: 3 :: Only
|
|
7
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
8
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
9
|
-
Classifier: Programming Language :: Python :: 3.13
|
|
10
|
-
Classifier: Programming Language :: Python :: 3.14
|
|
11
|
-
Requires-Python: >=3.11
|
|
12
|
-
Description-Content-Type: text/markdown
|
|
13
|
-
License-File: LICENSE
|
|
14
|
-
Requires-Dist: bioio>=3
|
|
15
|
-
Requires-Dist: bioio-ome-tiff>=1.4
|
|
16
|
-
Requires-Dist: bioio-ome-zarr>=3.0.3
|
|
17
|
-
Requires-Dist: bioio-tifffile>=1.3
|
|
18
|
-
Requires-Dist: fire>=0.7
|
|
19
|
-
Requires-Dist: ipywidgets>=8.1.8
|
|
20
|
-
Requires-Dist: jupyterlab-widgets>=3.0.16
|
|
21
|
-
Requires-Dist: matplotlib>=3.10.7
|
|
22
|
-
Requires-Dist: numpy>=2.2.6
|
|
23
|
-
Requires-Dist: pandas>=2.2.3
|
|
24
|
-
Requires-Dist: pillow>=12
|
|
25
|
-
Requires-Dist: pyarrow>=22
|
|
26
|
-
Requires-Dist: pyvista>=0.46.4
|
|
27
|
-
Requires-Dist: trame>=3.12
|
|
28
|
-
Requires-Dist: trame-vtk>=2.10
|
|
29
|
-
Requires-Dist: trame-vuetify>=3.1
|
|
30
|
-
Dynamic: license-file
|
|
31
|
-
|
|
32
|
-
# ome-arrow
|
|
33
|
-
|
|
34
|
-
Using OME specifications with Apache Arrow for fast, queryable, and language agnostic bioimage data.
|
|
File without changes
|
|
File without changes
|
|
File without changes
|