tiledb-bioimg


Nametiledb-bioimg JSON
Version 0.3.3 PyPI version JSON
download
home_pagehttps://github.com/TileDB-Inc/TileDB-Bioimaging
SummaryPackage supports all bio-imaging functionality provided by TileDB
upload_time2024-11-19 16:21:24
maintainerNone
docs_urlNone
authorTileDB, Inc.
requires_python>=3.8
licenseMIT
keywords tiledb bioimaging
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <a href="https://tiledb.com"><img src="https://github.com/TileDB-Inc/TileDB/raw/dev/doc/source/_static/tiledb-logo_color_no_margin_@4x.png" alt="TileDB logo" width="400"></a>

[![TileDB-BioImaging CI](https://github.com/TileDB-Inc/TileDB-BioImaging/actions/workflows/ci.yml/badge.svg)](https://github.com/TileDB-Inc/TileDB-BioImaging/actions/workflows/ci.yml)
![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/ktsitsi/32d48185733a4e7375e80e3e35fab452/raw/gist_bioimg.json)

# TileDB-BioImaging

Python package for:
- converting images stored in popular Biomedical Imaging formats to groups of TileDB arrays (& vice versa)
- exposing an expressive and efficient API (powered by TileDB) for querying such data.

## Features

### Ingestion to TileDB Groups of Arrays
    - OME-Zarr
    - OME-Tiff
    - Open-Slide

### Export from TileDB-Bioimaging Arrays to:
    - OME-Zarr
    - OME-Tiff

### Visualization Options

- [TileDB Cloud](https://cloud.tiledb.com) includes a built-in, pyramidal multi-resolution viewer: log in to TileDB Cloud to see an example image preview [here](https://cloud.tiledb.com/biomedical-imaging/TileDB-Inc/dbb7dfcc-28b3-40e5-916f-6509a666d950/preview)
- Napari: https://github.com/TileDB-Inc/napari-tiledb-bioimg

## Installation Prerequisites

OpenSlide Python requires that OpenSlide be installed separately prior to its installation.

Prior to proceeding with the below installation instructions, please [install OpenSlide as recommended by the OpenSlide Python library](https://openslide.org/api/python/#:~:text=OpenSlide%20Python%20requires%20OpenSlide%2C%20which%20must%20be%20installed%20separately).

## Quick Installation

- From PyPI:

      pip install 'tiledb-bioimg[full]'

- From source:

      git clone https://github.com/TileDB-Inc/TileDB-BioImaging.git
      cd TileDB-BioImaging

      pip install -e '.[full]'

## Windows Installation

After installing `Openslide` you should make sure that you create a link between your installation path and
the following default path `C:\openslide-win64\ `.

```cmd
mklink /D C:\openslide-win64\ [your-installation-path]\openslide-win64-20221217\
```

You can install the latest versions of `Openslide` for windows using the pre-built packages
found in the project's github page:
`https://github.com/openslide/openslide-bin/releases`

or in their website:
`https://openslide.org/download/`


## Examples
How to convert imaging data from standard biomedical formats to group of TileDB arrays.

### OME-Zarr to TileDB Group of Arrays
```python
from tiledb.bioimg.converters.ome_zarr import OMEZarrConverter
OMEZarrConverter.to_tiledb("path_to_ome_zarr_image", "tiledb_array_group_path")
```

### OME-Tiff to TileDB Group of Arrays
```python
from tiledb.bioimg.converters.ome_tiff import OMETiffConverter
OMETiffConverter.to_tiledb("path_to_ome_tiff_image", "tiledb_array_group_path")
```

### Open Slide to TileDB Group of Arrays
```python
from tiledb.bioimg.converters.openslide import OpenSlideConverter
OpenSlideConverter.to_tiledb("path_to_open_slide_image", "tiledb_array_group_path")
```

## Documentation
`API Documentation` is auto-generated. Following the instructions below:

```shell
quartodoc build && quarto preview
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/TileDB-Inc/TileDB-Bioimaging",
    "name": "tiledb-bioimg",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "tiledb, bioimaging",
    "author": "TileDB, Inc.",
    "author_email": "help@tiledb.io",
    "download_url": "https://files.pythonhosted.org/packages/44/4b/d3e5df3f748897377f0ad9d7284ec470ea974171496d9c245dd6cff897ca/tiledb_bioimg-0.3.3.tar.gz",
    "platform": "any",
    "description": "<a href=\"https://tiledb.com\"><img src=\"https://github.com/TileDB-Inc/TileDB/raw/dev/doc/source/_static/tiledb-logo_color_no_margin_@4x.png\" alt=\"TileDB logo\" width=\"400\"></a>\n\n[![TileDB-BioImaging CI](https://github.com/TileDB-Inc/TileDB-BioImaging/actions/workflows/ci.yml/badge.svg)](https://github.com/TileDB-Inc/TileDB-BioImaging/actions/workflows/ci.yml)\n![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/ktsitsi/32d48185733a4e7375e80e3e35fab452/raw/gist_bioimg.json)\n\n# TileDB-BioImaging\n\nPython package for:\n- converting images stored in popular Biomedical Imaging formats to groups of TileDB arrays (& vice versa)\n- exposing an expressive and efficient API (powered by TileDB) for querying such data.\n\n## Features\n\n### Ingestion to TileDB Groups of Arrays\n    - OME-Zarr\n    - OME-Tiff\n    - Open-Slide\n\n### Export from TileDB-Bioimaging Arrays to:\n    - OME-Zarr\n    - OME-Tiff\n\n### Visualization Options\n\n- [TileDB Cloud](https://cloud.tiledb.com) includes a built-in, pyramidal multi-resolution viewer: log in to TileDB Cloud to see an example image preview [here](https://cloud.tiledb.com/biomedical-imaging/TileDB-Inc/dbb7dfcc-28b3-40e5-916f-6509a666d950/preview)\n- Napari: https://github.com/TileDB-Inc/napari-tiledb-bioimg\n\n## Installation Prerequisites\n\nOpenSlide Python requires that OpenSlide be installed separately prior to its installation.\n\nPrior to proceeding with the below installation instructions, please [install OpenSlide as recommended by the OpenSlide Python library](https://openslide.org/api/python/#:~:text=OpenSlide%20Python%20requires%20OpenSlide%2C%20which%20must%20be%20installed%20separately).\n\n## Quick Installation\n\n- From PyPI:\n\n      pip install 'tiledb-bioimg[full]'\n\n- From source:\n\n      git clone https://github.com/TileDB-Inc/TileDB-BioImaging.git\n      cd TileDB-BioImaging\n\n      pip install -e '.[full]'\n\n## Windows Installation\n\nAfter installing `Openslide` you should make sure that you create a link between your installation path and\nthe following default path `C:\\openslide-win64\\ `.\n\n```cmd\nmklink /D C:\\openslide-win64\\ [your-installation-path]\\openslide-win64-20221217\\\n```\n\nYou can install the latest versions of `Openslide` for windows using the pre-built packages\nfound in the project's github page:\n`https://github.com/openslide/openslide-bin/releases`\n\nor in their website:\n`https://openslide.org/download/`\n\n\n## Examples\nHow to convert imaging data from standard biomedical formats to group of TileDB arrays.\n\n### OME-Zarr to TileDB Group of Arrays\n```python\nfrom tiledb.bioimg.converters.ome_zarr import OMEZarrConverter\nOMEZarrConverter.to_tiledb(\"path_to_ome_zarr_image\", \"tiledb_array_group_path\")\n```\n\n### OME-Tiff to TileDB Group of Arrays\n```python\nfrom tiledb.bioimg.converters.ome_tiff import OMETiffConverter\nOMETiffConverter.to_tiledb(\"path_to_ome_tiff_image\", \"tiledb_array_group_path\")\n```\n\n### Open Slide to TileDB Group of Arrays\n```python\nfrom tiledb.bioimg.converters.openslide import OpenSlideConverter\nOpenSlideConverter.to_tiledb(\"path_to_open_slide_image\", \"tiledb_array_group_path\")\n```\n\n## Documentation\n`API Documentation` is auto-generated. Following the instructions below:\n\n```shell\nquartodoc build && quarto preview\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Package supports all bio-imaging functionality provided by TileDB",
    "version": "0.3.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/TileDB-Inc/TileDB-Bioimaging/issues",
        "Documentation": "https://docs.tiledb.com",
        "Homepage": "https://github.com/TileDB-Inc/TileDB-Bioimaging"
    },
    "split_keywords": [
        "tiledb",
        " bioimaging"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b9edce28bb9581cf3564cef651a7d3e69bd0f16b9eabbaf1c9713555ead6a870",
                "md5": "03761ca75a7829964a8369ef9d77665f",
                "sha256": "2893a0de57282ca89b1c516b9ced571625137e97f77a99acaa703b38fd1031bc"
            },
            "downloads": -1,
            "filename": "tiledb_bioimg-0.3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "03761ca75a7829964a8369ef9d77665f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 43821,
            "upload_time": "2024-11-19T16:21:22",
            "upload_time_iso_8601": "2024-11-19T16:21:22.419609Z",
            "url": "https://files.pythonhosted.org/packages/b9/ed/ce28bb9581cf3564cef651a7d3e69bd0f16b9eabbaf1c9713555ead6a870/tiledb_bioimg-0.3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "444bd3e5df3f748897377f0ad9d7284ec470ea974171496d9c245dd6cff897ca",
                "md5": "dc63878bc88d9522d06626a0749a4913",
                "sha256": "75c5f3ccbb34c124b976bf31b35d03f9c295225503442c96652fffe4a79ba9be"
            },
            "downloads": -1,
            "filename": "tiledb_bioimg-0.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "dc63878bc88d9522d06626a0749a4913",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 38390188,
            "upload_time": "2024-11-19T16:21:24",
            "upload_time_iso_8601": "2024-11-19T16:21:24.933617Z",
            "url": "https://files.pythonhosted.org/packages/44/4b/d3e5df3f748897377f0ad9d7284ec470ea974171496d9c245dd6cff897ca/tiledb_bioimg-0.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-19 16:21:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "TileDB-Inc",
    "github_project": "TileDB-Bioimaging",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tiledb-bioimg"
}
        
Elapsed time: 2.73625s