Metadata-Version: 2.1
Name: h5analysis
Version: 0.0.57
Summary: Library to analyse, plot, and export data stored in HDF5 files.
Home-page: https://github.com/pmb399/H5Analysis
Author: Patrick Braun
Author-email: patrick.braun@lightsource.ca
License: MIT License
Project-URL: documentation, https://h5analysis.readthedocs.io/latest/
Project-URL: source, https://github.com/pmb399/H5Analysis
Project-URL: Tutorial, https://reixs.lightsource.ca/workshops/reixs-sxs-workshop-2023/
Project-URL: Bug Tracker, https://github.com/pmb399/H5Analysis/issues
Project-URL: Canadian Light Source, https://lightsource.ca
Project-URL: HDF Group, https://www.hdfgroup.org/
Project-URL: NeXus, https://manual.nexusformat.org/
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Information Technology
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Jupyter
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Natural Language :: English
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy >=1.26.1
Requires-Dist: pandas >2.1.0
Requires-Dist: bokeh >=3
Requires-Dist: scipy >=1.11.3
Requires-Dist: ipywidgets >=7.6.5
Requires-Dist: ipyfilechooser ==0.6.0
Requires-Dist: h5py >=3.10.0
Requires-Dist: shapely >=2.0.2
Requires-Dist: parse >=1.19.1
Requires-Dist: scikit-image >=0.19.2
Requires-Dist: colorcet >=3.1.0
Requires-Dist: matplotlib >=3.5.2
Requires-Dist: lmfit >=1.2.2
Provides-Extra: ffmpeg
Requires-Dist: ffmpeg >=1.4 ; extra == 'ffmpeg'

# H5Analysis

This is a library to analyse, plot, and export HDF5 data. The package is meant to provide a framework to load data in jupyter notebooks and enable data interaction.

## Installation

Install the package from PyPi with the pip package manager. This is the recommended way to obtain a copy for your local machine and will install all required dependencies.

```
$ pip install h5analysis
```

You will also need [Jupyter Notebook](https://github.com/jupyter) together with python 3 on your local machine.

In case that certain widgets aren't rendered properly, make sure to enable the appropriate jupyter extensions

```
$ jupyter nbextension enable --py widgetsnbextension
```

## Documentation

Extensive documentation can be found online on [ReadTheDocs](https://h5analysis.readthedocs.io/latest/index.html)
