{"id":28481517,"url":"https://github.com/insightsoftwareconsortium/itkioomezarrngff","last_synced_at":"2025-07-04T19:30:21.918Z","repository":{"id":50884039,"uuid":"195735080","full_name":"InsightSoftwareConsortium/ITKIOOMEZarrNGFF","owner":"InsightSoftwareConsortium","description":"ITK IO for images stored in OME-Zarr format.","archived":false,"fork":false,"pushed_at":"2024-10-21T13:32:02.000Z","size":155,"stargazers_count":10,"open_issues_count":18,"forks_count":5,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-30T15:21:20.500Z","etag":null,"topics":["imaging","insight-toolkit","itk","ome-zarr","ome-zarr-converter"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/InsightSoftwareConsortium.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-08T04:12:29.000Z","updated_at":"2024-12-11T03:56:32.000Z","dependencies_parsed_at":"2024-02-03T02:44:24.840Z","dependency_job_id":"d01db85d-d9ea-4ac4-8931-762bf5f9a756","html_url":"https://github.com/InsightSoftwareConsortium/ITKIOOMEZarrNGFF","commit_stats":{"total_commits":91,"total_committers":6,"mean_commits":"15.166666666666666","dds":0.5384615384615384,"last_synced_commit":"4e22d040d60b4dd88be0481b4f07619bb190a7cc"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/InsightSoftwareConsortium/ITKIOOMEZarrNGFF","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2FITKIOOMEZarrNGFF","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2FITKIOOMEZarrNGFF/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2FITKIOOMEZarrNGFF/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2FITKIOOMEZarrNGFF/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/InsightSoftwareConsortium","download_url":"https://codeload.github.com/InsightSoftwareConsortium/ITKIOOMEZarrNGFF/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2FITKIOOMEZarrNGFF/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263606300,"owners_count":23487603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["imaging","insight-toolkit","itk","ome-zarr","ome-zarr-converter"],"created_at":"2025-06-07T20:07:36.816Z","updated_at":"2025-07-04T19:30:21.912Z","avatar_url":"https://github.com/InsightSoftwareConsortium.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ITKIOOMEZarrNGFF\n\n![Build Status](https://github.com/InsightSoftwareConsortium/ITKIOOMEZarrNGFF/workflows/Build,%20test,%20package/badge.svg)\n\n[![PyPI Version](https://img.shields.io/pypi/v/itk-ioomezarrngff.svg)](https://pypi.python.org/pypi/itk-ioomezarrngff)\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/InsightSoftwareConsortium/ITKIOOMEZarrNGFF/blob/main/LICENSE)\n\n## Overview\n\nThis is an [ITK](https://itk.org/) external module for IO of images stored in [Zarr](https://zarr.dev/)-backed\n[OME-NGFF](https://ngff.openmicroscopy.org/0.4/) file format.\n\n## Installation\n\nThe `itk-ioomezarrngff` Python package is available on the Python Package Index.\n\n```sh\n\u003e python -m pip install itk-ioomezarrngff\n```\n\n## Example Usage\n\n### C++\n\nUsage from C++ should not require any special action. In special situations, you might need to invoke:\n\n```C++\nitk::OMEZarrNGFFImageIOFactory::RegisterOneFactory();\n```\n\n### Python\n\nIn Python, we need to explicitly specify the IO, otherwise DICOM IO will be invoked because it is the built-in default for directories. Example:\n```python\nimport sys\nimport itk\nimageio = itk.OMEZarrNGFFImageIO.New()\nimage = itk.imread(sys.argv[1], imageio=imageio)\nitk.imwrite(image, sys.argv[2], imageio=imageio, compression=False)\n```\n\n## Build Instructions\n\nITKIOOMEZarrNGFF is an ITK C++ external module. It may be built with `CMake` and build tools such as\nNinja, gcc, or MSVC.\n\nIn the future ITKIOOMEZarrNGFF may be made available as an ITK remote module for direct\ninclusion in the ITK build process.\n\n### Prerequisites\n\n- [CMake](https://cmake.org/)\n- [Perl](https://www.perl.org/)\n- [NASM](https://www.nasm.us/)\n- An existing C++ build of [ITK](https://itk.org/)\n\n### Building\n\nITKIOOMEZarrNGFF uses CMake for its build process.\n\n```sh\n# Create the build directory\n\u003e mkdir path/to/ITKIOOMEZarrNGFF-build\n\u003e cd path/to/ITKIOOMEZarrNGFF-build\n\n# Configure the project\npath/to/ITKIOOMEZarrNGFF-build \u003e cmake -DITK_DIR:PATH=\"path/to/ITK-build\" \"path/to/ITKIOOMEZarrNGFF\"\n\n# Build the project\npath/to/ITKIOOMEZarrNGFF-build \u003e cmake --build . --config \"Release\"\n```\n\n### Testing\n\nITKIOOMEZarrNGFF tests may be run with [CTest](https://cmake.org/cmake/help/latest/manual/ctest.1.html):\n\n```sh\npath/to/ITKIOOMEZarrNGFF-build \u003e ctest -C \"Release\"\n```\n\n### Wrapping\n\nSee the [ITK Software Guide](https://itk.org/ItkSoftwareGuide.pdf) for information on wrapping ITK external modules for Python.\n\n### Additional Notes\n\nITKIOOMEZarrNGFF depends on a fork of Google's [Tensorstore](https://github.com/google/tensorstore)\nlibrary for Zarr interoperation. The [InsightSoftwareConsortium/Tensorstore](https://github.com/InsightSoftwareConsortium/tensorstore)\nfork implements additional zip support, both for filesystem and in memory zip reading and writing.\n\n----------------\n\n## Acknowledgements\n\nITKIOOMEZarrNGFF was developed in part with support from:\n\n- [NIH NIMH BRAIN Initiative](https://braininitiative.nih.gov/) under award 1RF1MH126732.\n- The [Allen Institute for Neural Dynamics (AIND)](https://alleninstitute.org/division/neural-dynamics/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsoftwareconsortium%2Fitkioomezarrngff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finsightsoftwareconsortium%2Fitkioomezarrngff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsoftwareconsortium%2Fitkioomezarrngff/lists"}