Welcome - Documentation for h5analysis
===========================================

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

.. image:: img/home.png
  :width: 600
  :align: center
  :alt: Example of 2d data visualization

Authors and Contributors
======================================
* Patrick Braun (Canadian Light Source Inc.) - Code development and maintenance
* Teak Boyko (Canadian Light Source Inc.) - Beamline specific configurations

License
=======================
The package and its source code are availabe under the `MIT license <https://github.com/pmb399/H5Analysis?tab=MIT-1-ov-file#readme>`_.

.. toctree::
   :hidden:
   :caption: Get Started

   installation
   quickstart
   examples
   histogram
   scatter
   metadata
   objectmath

.. toctree::
   :hidden:
   :caption: API Documentation

   api

.. toctree::
   :hidden:
   :caption: Resources

   Python Wheel <https://pypi.org/project/h5analysis>
   Source Code <https://github.com/pmb399/H5Analysis>
   Issues <https://github.com/pmb399/H5Analysis/issues>