Documentation
======================

.. image:: _static/header.png
   :alt: Header
   :width: 90%
   :align: center

-----------------------------

This package is for analyzing pool boiling images and is from the paper: `BubbleID:A deep learning framework for bubble interface dynamics analysis <https://pubs.aip.org/aip/jap/article/136/1/014902/3300686/BubbleID-A-deep-learning-framework-for-bubble>`_. It combines tracking, segmentation, and classification models and is trained on manually labeled pool boiling data. It is used for departure classification, velocity interface prediction, bubble statistics extraction. It is built on ocsort and detectron2.

.. image:: _static/Data.jpg
   :alt: Data
   :width: 90%
   :align: center


.. toctree::
   :maxdepth: 2
   :caption: Table of Contents

   installation
   modules