https://github.com/insightsoftwareconsortium/itk-viewer
Multi-dimensional web-based image, mesh, and point set viewer
https://github.com/insightsoftwareconsortium/itk-viewer
Last synced: 3 months ago
JSON representation
Multi-dimensional web-based image, mesh, and point set viewer
- Host: GitHub
- URL: https://github.com/insightsoftwareconsortium/itk-viewer
- Owner: InsightSoftwareConsortium
- License: apache-2.0
- Created: 2022-11-01T20:37:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-02T21:21:16.000Z (about 1 year ago)
- Last Synced: 2025-04-07T18:21:12.179Z (9 months ago)
- Language: TypeScript
- Homepage: https://itk-viewer.on.fleek.co/
- Size: 4.1 MB
- Stars: 5
- Watchers: 14
- Forks: 3
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ITK-Viewer
[](https://github.com/InsightSoftwareConsortium/itk-viewer/actions/workflows/test.yml)
**Interactive visualization for multi-dimensional images, geometry, and point sets.**
ITK-Viewer is a modern visualization library designed to provide efficient and insightful data visualization. It allows you to view and interact with multi-dimensional images, geometric data, and point sets, making it an essential tool for data analysis and software development.
### Features
- **Elegant and Intuitive Interface**: Offers a user-friendly interface that enhances data exploration.
- **Flexible Integration**: Components can be customized and integrated into web browsers, terminal applications, or traditional desktop software.
- **HTML First Philosophy**: Utilizes standard Web Components in line with the [HTML First](https://html-first.com/) approach for seamless web development.
- **Enhanced Productivity**: Streamlines the process of adding visualizations to your software, making it faster and more enjoyable.
- **Sustainable Insights**: Facilitates a deeper understanding of your data through effective visualization techniques.
By leveraging ITK-Viewer, developers and researchers can create beautiful and functional visualizations with ease, leading to faster insights and better outcomes.
## Development
Contributions are welcome and appreciated.
### Build and test
```sh
npm i -g pnpm
pnpm i
pnpm build
pnpm test
```
### Watch rebuild packages and run Vite dev server
```sh
npm i -g pnpm
pnpm i
pnpm dev
```
Then open `http://localhost:5173/` in browser
### Publish Steps
1. In the branch that makes the modifications (or in another branch if you forgot)
run `pnpm changeset`. Commit the changeset markdown file.
1. Make a PR on `main` branch and merge. `release.yml` workflow sees there is
a new changeset markdown file and creates a new `chore: update versions` PR.
1. When ready to publish, merge the `chore: update version` PR on main and `release.yml`
will publish new NPM packages.
Recipe that was followed to setup changesets in this repo:
https://pnpm.io/using-changesets#releasing-changes
