Skip to main content

BubbleID Framework

Project description

Logo

bpypiv bpyv boldv blicense bpaper


This package is for analyzing pool boiling images and is from the paper: BubbleID:A deep learning framework for bubble interface dynamics analysis. 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.

Example plots generated from framework

  • This is an updated version of BubbleID for the past version please see here.

Installation:

  • First download and install the latest Microsoft C++ Build Tools
  • Create a new enviroment with python 3.10, we used anaconda
  • Update dependences:
    pip install --upgrade pip setuptools wheel
    
  • Install detectron2:
    pip install git+https://github.com/facebookresearch/detectron2
    
  • Install Additional Dependencies:
    pip install numpy==1.23 opencv-python filterpy super-gradients
    
  • Install BubbleID:
    pip install bubbleid
    

Using the BubbleID Framework:

The BubbleID framework has pretrained models for our in lab pool boiling images. This section goes over how to use these models to analyze image data. These models may need finetuning with your own data. More on this is provided later.

Model Weights Description
Instance Segmentation Link Model weights for the instance segmentation model.
Classification Link Model weights for the departure classification model.

For the model both an avi video and corresponding .jpg images of each frame must be provided.

Tutorials

  • For convience, tutorials are provided in the github to demonstrate how to use BubbleID to generate your own data.
  • The tutorials use the testing data found here: data1

Training your own model:

  1. Annotate image data, Lableme was used for our dataset.
  2. Convert labelme dataset to yolo format
  3. Run training
  4. See Using the BubbleID Framework but use your new model weights

Example plots generated from framework

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bubbleid-0.0.8.tar.gz (37.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bubbleid-0.0.8-py3-none-any.whl (38.8 kB view details)

Uploaded Python 3

File details

Details for the file bubbleid-0.0.8.tar.gz.

File metadata

  • Download URL: bubbleid-0.0.8.tar.gz
  • Upload date:
  • Size: 37.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.16

File hashes

Hashes for bubbleid-0.0.8.tar.gz
Algorithm Hash digest
SHA256 8a0936a5c28a6a740fc13ae7c064dfea243348b95be80a56ecad4ec89c230225
MD5 6652fee6575f0c1bc484d8aa67a1c278
BLAKE2b-256 5a5993511086ea7ca4035b75fd06a2033a14aa91d0214ae32e48f4bf2aa64892

See more details on using hashes here.

File details

Details for the file bubbleid-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: bubbleid-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 38.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.16

File hashes

Hashes for bubbleid-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 2f0cfee59715dfc30f587b905fa34f50e848c15cd2ea6df19f360433b019351e
MD5 11e88a893016b08a6235eb70fd7c9a83
BLAKE2b-256 510a5575cabccd76f9553901dd1ad2341621329245d968bc602a37b9a5328acd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page