https://github.com/silx-kit/vscode-h5web

VSCode extension to explore and visualize HDF5 files
https://github.com/silx-kit/vscode-h5web

hdf5 vscode-extension

Last synced: 3 months ago
JSON representation

VSCode extension to explore and visualize HDF5 files

• Host: GitHub
• URL: https://github.com/silx-kit/vscode-h5web
• Owner: silx-kit
• License: mit
• Created: 2022-07-05T11:32:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T08:06:20.000Z (5 months ago)
• Last Synced: 2024-09-17T08:49:26.063Z (5 months ago)
• Topics: hdf5, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=h5web.vscode-h5web
• Size: 1.42 MB
• Stars: 31
• Watchers: 6
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# [H5Web](https://h5web.panosc.eu/) for Visual Studio Code

Explore and visualise **HDF5 files** directly in Visual Studio Code with

[H5Web](https://h5web.panosc.eu/) and its `H5WasmProvider`.

![GIF recording](./assets/vscode-h5web.gif)

## Supported HDF5 file extensions

Out of the box, the H5Web viewer is configured as the default editor for the

following file extensions: `.h5`, `.hdf`, `.hdf5`, `.nx`

([NeXus](https://manual.nexusformat.org/index.html)), `.nxs`, `.nx5`, `.nexus`,

`.cxi`

([Coherent X-ray Imaging](https://raw.githubusercontent.com/cxidb/CXI/master/cxi_file_format.pdf)),

`.nc` ([netCDF4](https://docs.unidata.ucar.edu/nug/current/)), `.nc4`,

[`.loom`](http://linnarssonlab.org/loompy/format/),

[`jld2`](https://github.com/JuliaIO/JLD2.jl).

To add more extensions, don't hesitate to

[open an issue](https://github.com/silx-kit/vscode-h5web/issues/new) or

[a pull request](https://github.com/silx-kit/vscode-h5web/pulls). Alternatively,

you can use VS Code's `workbench.editorAssociations` setting to set H5Web as the

default editor for additional extensions:

```json

"workbench.editorAssociations": {

  "*.foo": "h5web.viewer",

},

```

You can also open any file in H5Web with **right click -> Open with... -> H5Web

(any extension)**, or, if you've already opened the file, by invoking **View:

Reopen Editor With...** from the command palette:

![GIF recording](./assets/vscode-openwith.gif)

Note that some of the extensions configured to open with H5Web are not

guaranteed to map to HDF5 files. For instance, the `.nc` extension is also used

for netCDF3 files, which are **not** based on HDF5 and are therefore not

compatible with H5Web. If this is an issue, you can use the

`workbench.editorAssociations` to restore the default editor association as

follows:

```json

"workbench.editorAssociations": {

  "*.nc": "default",

},

```

## Supported HDF5 compression plugins

The extension supports reading datasets compressed with any of the plugins

available in

[[email protected]](https://github.com/h5wasm/h5wasm-plugins/tree/v0.0.3?tab=readme-ov-file#included-plugins).

## Known limitations

This extension uses [h5wasm](https://github.com/usnistgov/h5wasm) to read HDF5

files and therefore suffers from the following limitations:

- Files bigger than 2GB cannot be opened automatically from the VS Code

  Explorer. You will need to browse for them manually from the H5Web webview

  editor when requested.

- External links cannot be resolved.