https://github.com/alleninstitute/vis
Typescript packages for building big-data visualization tools & components, with examples for a variety of common data types & formats
https://github.com/alleninstitute/vis
big-data toolkit visualization webgl
Last synced: about 1 year ago
JSON representation
Typescript packages for building big-data visualization tools & components, with examples for a variety of common data types & formats
- Host: GitHub
- URL: https://github.com/alleninstitute/vis
- Owner: AllenInstitute
- License: bsd-3-clause
- Created: 2024-02-06T18:58:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T16:59:59.000Z (about 1 year ago)
- Last Synced: 2025-04-08T17:34:10.947Z (about 1 year ago)
- Topics: big-data, toolkit, visualization, webgl
- Language: TypeScript
- Homepage: https://alleninstitute.github.io/vis/
- Size: 2.49 MB
- Stars: 5
- Watchers: 7
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Allen Institute Visualization TypeScript Libraries
This repository contains a collection of TypeScript libraries to help software engineers building scalable visualization tools at the Allen Institute. It houses the `vis-[package name]` packages on the Allen Institute GitHub organization's NPM package registry.
**The published packages are in alpha or beta states. They may fundamentally change as we continue building out functionality.** They are used in a production environment so they are relatively stable, but the APIs are not yet finalized.
## Available Packages
The following is the list of packages and their descriptions:
- `vis-dzi`: A renderer for [Deep Zoom Images](https://en.wikipedia.org/wiki/Deep_Zoom)
- `vis-geometry`: A collection of vector functions for 2D and 3D geometry
- `vis-omezarr`: A renderer for [OME-Zarr](https://ngff.openmicroscopy.org/latest/) datasets
- `vis-core`: A collection of useful utilities used to build our big-data, scalable, data visualization tools, including the DZI viewer, OME-Zarr viewer, and our scatterplot tool "Scatterbrain" for the [ABC Atlas](https://knowledge.brain-map.org/abcatlas) in the Brain Knowledge Platform web application
We use [Semantic Versioning](https://semver.org/) for our packages. As of November 2024, all of them are in the `0.0.x` range, indicating that they are in early development.
## Level Of Support
We are planning on occasional updating this tool with no fixed schedule. Community involvement is encouraged through both issues and pull requests.
## Examples
A deployed version our our examples are located at [https://alleninstitute.github.io/vis](https://alleninstitute.github.io/vis).
See the `examples` directory for example projects using the packages. Over time, these examples will become more fully featured as the base tooling becomes more mature.
For details on running or adding new examples, see the `docs/examples.md` file.
## Contributing
Contributions are welcome! We're currently breaking apart the Scatterbrain component into smaller, more manageable packages. If you have a package that you think would be useful to others, please open a PR.
See the CONTRIBUTING.md file for more information on how to contribute to the project!
## Installation for Development
This project uses [Node.js](https://nodejs.org) and [pnpm](https://pnpm.io/). We use [Volta](https://volta.sh/) to manage the versions of each. If you're not using Volta, check the "volta" key in the root `package.json` for the Node and pnpm versions we're using when developing.
Volta has experimental support for pnpm, so [follow the steps on their docs](https://docs.volta.sh/advanced/pnpm) to get it enabled.
## Using the Libraries
See the `docs/using-packages.md` file for information on how to use the packages in your own projects.