search

Kitware / glance

Kitware Glance is an open-source web application developed at Kitware for visualizing volumetric images, molecular structures, geometric objects, and point clouds. It is part of the ParaView platform and can serve as a foundation for building custom web-based visualization applications involving ITK.js and VTK.js.
https://kitware.github.io/glance
BSD 3-Clause "New" or "Revised" License
249 stars 87 forks source link

readme

Glance

Introduction

Glance is an open-source, javascript visualization application created by Kitware, based on Visualization Toolkit (VTK), and intended to serve as a light-weight companion to Paraview. It is part of the ParaView Web suite of tools.

Learning Resources

Live Demonstrations

As a javascript application, Glance can be run by pointing any browser at an appropriate URL or loading an HTML file.

Click on this link to run the live version of Glance.

Building

The prerequisites are git and node.js + npm.

If you wish to view, enhance, or adapt this application in any way, you can access and run the freely available source code from any platform using the following commands:

$ git clone https://github.com/Kitware/glance.git
$ cd glance/
$ npm install
$ npm run build
$ npm run dev

This will run a development build and you can visit the application at http://localhost:9999.

Deploying to Production

To generate a production build, use the following commands:

$ npm run build:release

This will output the final bundle and assets to dist/. You can then recursively copy all of those files into the web location of your choice. As there is no server-side code involved, all you need is some web hosting!

If you make changes to any of the ITK filtering code under itk/, you should run the following command from the root folder. For more information, check out itk.js.

$ npx itk-js build itk/

Building as a standalone file

ParaView can use Glance for scene exports. To generate a standalone HTML file embedding Glance to use with ParaView, you can run:

$ npm run build:inline

This will generate a self-contained dist/ParaViewGlance.html file that you can directly use as a template in ParaView VTKJS scene export.

Reporting Bugs and Making Contributions

If you have found a bug or have a suggestion for improving Glance:

  1. If you have source code to contribute, please fork the github repository into your own github account, create a branch with your changes, and then create a merge request with the main repo.

  2. If you have a bug to report or a feature to request, please open an entry in the Glance Issue Tracker.

License

Glance is distributed under the OSI-approved BSD 3-clause License. See COPYRIGHT and LICENSE for details. For additional licenses, refer to ParaView Licenses.