{"id":20215412,"url":"https://github.com/kitwaremedical/kitwarefileviewers","last_synced_at":"2025-04-10T14:22:18.389Z","repository":{"id":143102796,"uuid":"588916731","full_name":"KitwareMedical/KitwareFileViewers","owner":"KitwareMedical","description":"Browser extension to open URL in Kitware online viewers","archived":false,"fork":false,"pushed_at":"2023-05-12T21:26:20.000Z","size":3425,"stargazers_count":14,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-24T13:04:29.992Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/KitwareMedical.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://www.kitware.eu/contact-us/","kitware.eu"]}},"created_at":"2023-01-14T13:22:51.000Z","updated_at":"2024-05-29T02:09:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"aa011908-5b95-400b-98d8-d3f92734ae57","html_url":"https://github.com/KitwareMedical/KitwareFileViewers","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KitwareMedical%2FKitwareFileViewers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KitwareMedical%2FKitwareFileViewers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KitwareMedical%2FKitwareFileViewers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KitwareMedical%2FKitwareFileViewers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KitwareMedical","download_url":"https://codeload.github.com/KitwareMedical/KitwareFileViewers/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248233935,"owners_count":21069493,"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-14T06:22:03.964Z","updated_at":"2025-04-10T14:22:18.381Z","avatar_url":"https://github.com/KitwareMedical.png","language":"JavaScript","funding_links":["https://www.kitware.eu/contact-us/","kitware.eu"],"categories":[],"sub_categories":[],"readme":"# KitwareFileViewers\r\n\r\nCross-browser extension that lets you conveniently open URLs with Kitware online viewers such as Glance, VTK.js or itk-vtk-viewer. It can also open 🖥️ desktop viewers such as 3D Slicer.\r\n\r\n![Screenshot](images/Screenshot.png)\r\n*Example of usage with [Girder](https://girder.readthedocs.io/en/latest/) (e.g. https://data.kitware.com)*\r\n\r\n\r\n# Install\r\n\r\nInstall the extension from your browser web store:\r\n - [Chrome](https://chrome.google.com/webstore/detail/kitware-file-viewers/lklknpjabnmfefcfhmhdnhebkpindcld) \r\n - [Firefox](https://addons.mozilla.org/en-US/firefox/addon/kitware-file-viewers/)\r\n - [Edge](https://microsoftedge.microsoft.com/addons/detail/kitware-file-viewers/kfejllcdobijgoijjpfcbaoicjbdkhfb)\r\n\r\n# Viewers\r\n\r\nThe following 💻 online viewers are supported:\r\n - [Kitware Glance](https://kitware.github.io/glance/)\r\n - [Kitware VolView](https://volview.kitware.com/)\r\n - [itk-vtk-viewer](https://kitware.github.io/itk-vtk-viewer/docs/)\r\n - [VTK.js viewer examples](https://kitware.github.io/vtk-js/examples/)\r\n\r\nThe following 🖥️ desktop viewers are supported:\r\n - [3D Slicer](https://www.slicer.org/)\r\n\r\n\r\n\r\n|              |                |\r\n|:------------------:|:------------------: |\r\n|![VolView](images/VolView.png) *Kitware VolView* | ![Glance](images/Glance.png) *Kitware Glance*\r\n|![itk-vtk-viewer](images/itk-vtk-viewer.png) *itk-vtk-viewer*| ![VTK.js examples](images/vtk-js-examples.png) *VTK.js examples* |\r\n| ![Slicer](images/Slicer.png) *3D Slicer*\r\n\r\n\r\n## File support\r\n\r\nMost viewers need to be opened with the file extension as parameter.\r\nFirst the extension attempts to extract the file extension from the URL.\r\nBecause some URLs may not contain the file extension, as an optional second step, the extension downloads a few bytes of the file and attempts to detect the file extension by reading the file headers.\r\nThis is not perfect and does not work well with ZIP archives because no unzipping is performed (yet).\r\nHere is the explicit list of files supported by the extension :\r\n - dcm (DICOM)\r\n - glance (Kitware glance state file)\r\n - mha (Meta)\r\n - nii (Nifti)\r\n - nrrd\r\n - obj\r\n - obz (Zip of obj+mtl)\r\n - stl\r\n - vti (vtkImageData)\r\n - vtk (Legacy VTK)\r\n - vtkjs (Zip)\r\n - vtp (vtkPolyData)\r\n - vtu (vtkUnstructedGrid)\r\n - json (VolView resource file)\r\n\r\n# Usage\r\n\r\nRight click on a link in any webpage to open the context menu.\r\n\r\nYou can also select the text of an url and right click to open the context menu.\r\n\r\n## Local files\r\n\r\nYou can also visualize local files. You just have to serve your files. Here are some one-liners to help you do so:\r\n\r\n### Python\r\n\r\n```\r\npython.exe -m http.server 8000\r\n```\r\n\r\n### Node.js\r\n\r\n```\r\nnpm install -g http-server\r\nhttp-server -p 8000 --cors\r\n```\r\n\r\nThen you can open on your browser localhost:8000 to see your files.\r\n\r\n## 3D Slicer\r\n\r\nShall you want to open your URLs with 3D Slicer, you need to save the [LoadRemoteFile module](https://github.com/PerkLab/SlicerSandbox/blob/master/LoadRemoteFile/LoadRemoteFile.py) into the qt-scripted-modules folder of 3D Slicer.\r\nIt will work automatically on Windows. There is [more setup required](https://github.com/PerkLab/SlicerSandbox/blob/master/README.md#loadremotefile) on other OS.\r\n\r\n\r\n# Browser support\r\n\r\nIt is known to work with at least the following desktop browsers:\r\n - Firefox 108.0.2\r\n - Chrome 108.0.5359.126\r\n - Edge 109.0.1518.55\r\n\r\nIt should work (not tested) with:\r\n - all chromium-based browsers such as Opera\r\n\r\nA bit more work is required to support:\r\n - Safari\r\n\r\n# Debug\r\n\r\nTo develop and debug, you can manually install the extension by following those tutorials \r\n\r\n - Chrome: Follow the [Loading unpacked extension tutorial](https://developer.chrome.com/docs/extensions/mv3/getstarted/development-basics/#load-unpacked).\r\n - Firefox: Follow the [Temporary installation tutorial](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/).\r\n - Edge: Follow the [Sideload an extension tutorial](https://learn.microsoft.com/en-us/microsoft-edge/extensions-chromium/getting-started/extension-sideloading).\r\n\r\n\r\n# Packaging #\r\n\r\n## Manifest v2 package ##\r\n\r\nCopy manifests/manifest-v2.json into manifest.json.\r\nCreate a zip archive:\r\n```\r\ncp manifests/manifest-v2.json manifest.json\r\ntar.exe -a -c -f KitwareFileViewers-v1.0.8-manifest-v2.zip images scripts LICENSE manifest.json options.html README.md\r\n```\r\n\r\n\r\n## Manifest v3 package ##\r\n\r\nCopy manifests/manifest-v3.json into manifest.json.\r\nCreate a zip archive:\r\n```\r\ncp manifests/manifest-v3.json manifest.json\r\ntar.exe -a -c -f KitwareFileViewers-v1.0.8-manifest-v3.zip images scripts LICENSE manifest.json options.html README.md\r\n```\r\n\r\n# Help and Support #\r\n[Kitware](https://www.kitware.com/) offers advanced software R\u0026D solutions and services. Find out how we can help with your next project.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitwaremedical%2Fkitwarefileviewers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitwaremedical%2Fkitwarefileviewers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitwaremedical%2Fkitwarefileviewers/lists"}