Metadata-Version: 2.1
Name: jupyterlab_h5web
Version: 0.0.7
Summary: A JupyterLab extension to explore and visualize HDF5 file contents.
Home-page: https://github.com/silx-kit/jupyterlab-h5web
Author: European Synchrotron Radiation Facility
Author-email: h5web@esrf.fr
License: MIT
Description: # jupyterlab-h5web
        
        ![Github Actions Status](https://github.com/silx-kit/jupyterlab-h5web/workflows/Build/badge.svg)
        [![PyPI version](https://badge.fury.io/py/jupyterlab-h5web.svg)](https://badge.fury.io/py/jupyterlab-h5web)
        [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/silx-kit/jupyterlab-h5web/HEAD?urlpath=lab/tree/example.ipynb)
        
        **This extension is still in active development. Please report any encountered
        issue.**
        
        ![Demo](https://user-images.githubusercontent.com/2936402/114533096-d5e68000-9c4d-11eb-81d3-67d313c9216f.gif)
        
        **jupyterlab-h5web** is a JupyterLab extension to explore and visualize HDF5
        file contents, using the web-based viewer
        [h5web](https://github.com/silx-kit/h5web). h5web supports the
        [NeXus](https://www.nexusformat.org/) format.
        
        See [Usage](README.md#Usage) for more details.
        
        ## Requirements
        
        - JupyterLab 2 (JupyterLab 3 can be used but is not officially supported).
        
        ## Install
        
        _Note: You will need NodeJS to install the extension._
        
        ```bash
        pip install jupyterlab_h5web
        jupyter lab build
        ```
        
        To enable support for additional filters such as
        [blosc](https://github.com/Blosc/hdf5-blosc) or
        [bitshuffle](https://github.com/kiyo-masui/bitshuffle):
        
        ```bash
        pip install jupyterlab_h5web[full]
        jupyter lab build
        ```
        
        This will install [hdf5plugin](https://pypi.org/project/hdf5plugin/) in addition
        to the extension.
        
        ## Usage
        
        This extension enables opening HDF5 files in a JupyterLab tab and exploring HDF5
        files in Jupyter notebooks.
        
        ### In JupyterLab
        
        You can double-click on an HDF5 file or right-click _Open with_ -> _h5web_ to
        launch a tab.
        
        This tab is composed of a sidebar, where you can explore the structure of the
        HDF5 file, and of a main area where the visualization of the selected entity
        takes place. This visualization is controlled by the upper-right button that can
        toggle between:
        
        - _Display_: visualize datasets using `Line`, `Heatmap` or `Matrix`
          visualizations.
        - _Inspect_: show the metadata and attributes of any entity
        
        _Note: Opening a file this way will fetch the whole file. This is a limitation
        for heavy files and should be fixed soon._
        
        ### In Jupyter notebooks
        
        To open a HDF5 file with H5Web, use the `H5Web` widget in a notebook cell:
        
        ```python
        from jupyterlab_h5web import H5Web
        
        H5Web('<path to the HDF5 file>')
        ```
        
        An example is provided in [example.ipynb](example.ipynb).
        
        _Note: The limitation of the JupyterLab tab does not apply here: the widget will
        only fetch HDF5 contents on-demand._
        
        ### Supported file formats
        
        **jupyter-h5web** detects HDF5 files based on their file extensions. The viewer
        works for the following extensions:
        
        - "Classic" HDF5: `.h5`, `.hdf5`
        - [NeXus](https://www.nexusformat.org/): `.nexus`, `.nx`, `.nxs`
        - [CXI](https://cxidb.org/cxi.html): `.cxi`
        
        For other types of files, you can change the extension to one of the supported
        extensions or, if it is widespread,
        [open an issue](https://github.com/silx-kit/jupyterlab-h5web/issues) to discuss
        its support.
        
        ## Changelog
        
        See https://github.com/silx-kit/jupyterlab-h5web/releases.
        
        ## Troubleshoot
        
        ### Check the server extension
        
        If you are seeing the frontend extension but it is not working, check that
        `jupyterlab_hdf` is installed and enabled.
        
        It should be listed when running:
        
        ```bash
        jupyter serverextension list
        ```
        
        If `jupyterlab_hdf` does not appear, try to install it manually:
        
        ```
        pip install jupyterlab_hdf
        ```
        
        and to enable it:
        
        ```
        jupyter serverextension enable jupyterlab_hdf
        ```
        
        ### Check the frontend extension
        
        If `jupyterlab_hdf` is installed and enabled but you are not seeing the
        frontend, check the frontend is installed:
        
        ```bash
        jupyter labextension list
        ```
        
        If it is installed, try:
        
        ```bash
        jupyter lab clean
        jupyter lab build
        ```
        
        ## Uninstall
        
        ```bash
        pip uninstall jupyterlab_h5web
        jupyter labextension uninstall jupyterlab-h5web
        ```
        
Keywords: Jupyter,JupyterLab
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Framework :: Jupyter
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: full
