跳转到主要内容

A JupyterLab extension to explore and visualize HDF5 file contents.

项目描述

jupyterlab-h5web

Github Actions Status PyPI version Binder

Demo

jupyterlab-h5web是一个用于探索和可视化HDF5文件内容的JupyterLab扩展,使用基于Web的查看器h5web。h5web支持NeXus格式。

有关详细信息,请参阅用法

需求

  • JupyterLab 4

下表显示了较早的JupyterLab版本

兼容性表

JupyterLab 2 JupyterLab 3 JupyterLab 4
扩展版本范围 0.0.1 - 0.3.0 1.0.0 - 8.0.0 10.0.0 - ...

安装

使用pip

pip install jupyterlab_h5web

为了启用对额外过滤器(如bloscbitshuffle)的支持

pip install jupyterlab_h5web[full]

这将安装hdf5plugin,除了扩展之外。

使用conda

conda install -c conda-forge jupyterlab-h5web

用法

此扩展允许在JupyterLab标签中打开HDF5文件,并在Jupyter笔记本中探索HDF5文件。

在JupyterLab中

您可以通过双击HDF5文件或右键单击打开方式 -> h5web来打开一个标签。

此标签由一个侧边栏和一个主区域组成,您可以在侧边栏中探索HDF5文件的结构,在主区域中进行所选实体的可视化。此可视化由右上角的按钮控制,可以在以下选项之间切换:

  • 显示:使用线热图矩阵可视化来可视化数据集。
  • 检查:显示任何实体的元数据和属性

在Jupyter笔记本中

要使用H5Web打开HDF5文件,请在一个笔记本单元中使用H5Web小部件。

from jupyterlab_h5web import H5Web

H5Web('<path to the HDF5 file>')

可以通过右下角的把手调整单元的高度。

示例请参阅example.ipynb

支持的文件格式

jupyter-h5web根据文件扩展名检测HDF5文件。查看器适用于以下扩展

  • “经典”HDF5:.h5.hdf5
  • NeXus.nexus.nx.nxs
  • CXI.cxi
  • NetCDF4.nc.nc4
  • Loom.loom

对于其他类型的文件,您可以将其扩展名更改为支持的扩展名,或者如果您认为它很常见,可以打开一个问题来讨论其支持。

变更日志

请参阅https://github.com/silx-kit/jupyterlab-h5web/releases

故障排除

如果以下说明不能解决您的问题,您可以在GitHub上打开问题

检查服务器扩展

如果您看到前端扩展但无法使用,请检查jupyterlab_h5web是否已安装并启用。

运行时应该会列出

jupyter server extension list

如果jupyterlab_h5web未出现或已禁用,请尝试启用它

jupyter server extension enable jupyterlab_h5web

检查前端扩展

如果jupyterlab_h5web已安装并启用,但您看不到前端,请检查前端是否已安装

jupyter labextension list

卸载

pip uninstall jupyterlab_h5web

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪一个,请了解更多关于安装包的信息。

源分发

jupyterlab_h5web-12.3.0.tar.gz (489.1 kB 查看哈希值)

上传时间 源代码

构建版本

jupyterlab_h5web-12.3.0-py3-none-any.whl (780.2 kB 查看哈希值)

上传时间 Python 3