Skip to content

Latest commit

 

History

History
42 lines (23 loc) · 2.54 KB

README.md

File metadata and controls

42 lines (23 loc) · 2.54 KB
Raw

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
  • vis-geometry: A collection of vector functions for 2D and 3D geometry
  • vis-omezarr: A renderer for OME-Zarr datasets
  • vis-scatterbrain: A collection of useful utilities used to build our big-data, scalable, scatterplot tool "Scatterbrain" in the Brain Knowledge Platform (will be renamed to vis-core in the future)

We use Semantic Versioning 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

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 and pnpm. We use Volta 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 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.