{"id":20399826,"url":"https://github.com/kitware/light-viz","last_synced_at":"2025-06-27T23:34:36.299Z","repository":{"id":51509053,"uuid":"47779516","full_name":"Kitware/light-viz","owner":"Kitware","description":"Scientific Visualization application for tailored post-processing relying on a ParaViewWeb backend.","archived":false,"fork":false,"pushed_at":"2021-05-11T13:59:21.000Z","size":7874,"stargazers_count":20,"open_issues_count":16,"forks_count":7,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-08T15:05:21.918Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://kitware.github.io/light-viz/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kitware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-10T18:20:46.000Z","updated_at":"2023-09-21T21:55:50.000Z","dependencies_parsed_at":"2022-08-22T02:40:53.616Z","dependency_job_id":null,"html_url":"https://github.com/Kitware/light-viz","commit_stats":null,"previous_names":[],"tags_count":62,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Flight-viz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Flight-viz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Flight-viz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Flight-viz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kitware","download_url":"https://codeload.github.com/Kitware/light-viz/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248574505,"owners_count":21127028,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T04:34:05.882Z","updated_at":"2025-04-12T13:41:44.990Z","avatar_url":"https://github.com/Kitware.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## [LightViz](http://kitware.github.io/light-viz/)\n\n[![Build Status](https://travis-ci.org/Kitware/light-viz.svg)](https://travis-ci.org/Kitware/light-viz)\n[![Dependency Status](https://david-dm.org/kitware/light-viz.svg)](https://david-dm.org/kitware/light-viz)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n![npm-download](https://img.shields.io/npm/dm/light-viz.svg)\n![npm-version-requirement](https://img.shields.io/badge/npm-\u003e=3.0.0-brightgreen.svg)\n![node-version-requirement](https://img.shields.io/badge/node-\u003e=5.0.0-brightgreen.svg)\n\n### Goal ###\n\nProvide a tailored user interface for Scientific Visualization using ParaViewWeb as backend.\n\nThis project really aims to illustrate what can be done with ParaViewWeb but should not be used for production usage as it has been deprecated and is no longer supported.\n\n## Installation\n\n```\n$ npm install -g light-viz\n```\n\nAfter installing the package you will get one executable **LightViz** with\nthe following set of options.\n\n```\n$ LightViz \n\n  Usage: LightViz [options]\n\n  Options:\n\n    -h, --help                   output usage information\n    -V, --version                output the version number\n    -p, --port [8080]            Start web server with given port\n    -d, --data [directory]       Data directory to serve\n    -s, --server-only            Do not open the web browser\n    \n    --paraview [path]            Provide the ParaView root path to use\n    --offscreen                  Use flag to specify that ParaView should be used in Offscreen mode\n    \n    --data-analysis              Inspect data directory and compute metadata\n    \n    --config [path]              Provide a Lightviz config file to use\n    --profile [profile]          Specify which profile from the config file to use\n    \n    --add-dataset [path]         Specify a dataset to add to the given data directory.  Requires the description and data flags\n    --description [description]  Specify the description for the dataset being added\n    --autoApply                  Optional for use with --add-dataset.  Specifies that apply/reset buttons are not needed with the dataset\n```\n## Documentation\n\nSee the [documentation](https://kitware.github.io/light-viz) for a\ngetting started guide, advanced documentation, and API descriptions.\n\n\n## Development\n\nTo start developing light-viz, first clone the repository:\n\n```sh\n$ git clone https://github.com/Kitware/light-viz.git\n```\n\nTo set up the dependencies for light-viz run the following.  Note that this must be re-run every time\nthe dependencies for light-viz are modified.\n\n```sh\n$ npm install\n```\n\nWhen first setting up light-viz for development, it may be helpful to have npm\ninstall a symlink to the latest version that can be executed from the command line\nin the folder (presumably in the path) where npm is located.  To do this run:\n\n```sh\n$ npm link\n```\n\nNow make changes and see what happens.  If you have changed the python code\nthat runs on the paraview server side, you will have to re-run the LightViz\nexecutable that is generated by `npm link`.  If you have changed the JavaScript\ncode, running the following command and refreshing the page should be sufficient.\n\n```sh\n$ npm run build\n```\n\nBefore you commit, please run:\n```sh\n$ npm run build:release\n```\nThis creates a minified version of the light-viz JavaScript code in dist/LightViz.js\nwhich should be added to your commit.\n\n#### Licensing\n\n**light-viz** aka LightViz is licensed under [BSD Clause 3](LICENSE).\n\n#### Getting Involved\n\nFork our repository and do great things. At [Kitware](http://www.kitware.com),\nwe've been contributing to open-source software for 15 years and counting, and\nwant to make **light-viz** useful to as many people as possible.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitware%2Flight-viz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitware%2Flight-viz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitware%2Flight-viz/lists"}