https://github.com/zeiss/czicheck

Checking CZI Documents
https://github.com/zeiss/czicheck

Last synced: 4 days ago
JSON representation

Checking CZI Documents

• Host: GitHub
• URL: https://github.com/zeiss/czicheck
• Owner: ZEISS
• License: mit
• Created: 2023-10-13T21:02:54.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-28T12:27:10.000Z (16 days ago)
• Last Synced: 2024-10-28T16:12:04.688Z (16 days ago)
• Language: C++
• Size: 228 KB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# CZICheck

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![REUSE status](https://api.reuse.software/badge/github.com/ZEISS/czicheck)](https://api.reuse.software/info/github.com/ZEISS/czicheck)

[![CMake](https://github.com/ZEISS/czicheck/actions/workflows/cmake.yml/badge.svg?branch=main&event=push)](https://github.com/ZEISS/czicheck/actions/workflows/cmake.yml)

[![CodeQL](https://github.com/ZEISS/czicheck/actions/workflows/codeql.yml/badge.svg?branch=main&event=push)](https://github.com/ZEISS/czicheck/actions/workflows/codeql.yml)

[![MegaLinter](https://github.com/ZEISS/czicheck/actions/workflows/mega-linter.yml/badge.svg?branch=main&event=push)](https://github.com/ZEISS/czicheck/actions/workflows/mega-linter.yml)

CZICheck is a command-line application developed using libCZI, enabling users to assess the integrity and structural correctness of a CZI document.

Checking the validity of a CZI becomes more complex the closer one is to the application domain (e.g. application-specific metadata).

So this console application is more of a utility to help users who are directly using libCZI, or its python wrapper [pylibCZIrw](https://pypi.org/project/pylibCZIrw/), than it is an official validation tool for any ZEISS-produced CZIs.

CZICheck runs a collection of *checkers* which evaluate a well defined rule.

Each *checker* reports back findings of type Fatal, Warn, or Info.

Please check the tool's internal help by running `CZICheck.exe --help` and check additional documentation [here](documentation/czicheck.md).

## Guidelines

[Code of Conduct](./CODE_OF_CONDUCT.md)  

[Contributing](./CONTRIBUTING.md)

## Disclaimer

ZEISS, ZEISS.com are registered trademarks of Carl Zeiss AG.