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.2.tar.gz (33.1 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.2-py3-none-any.whl (34.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bubbleid-0.0.2.tar.gz
  • Upload date:
  • Size: 33.1 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.2.tar.gz
Algorithm Hash digest
SHA256 90ab9936c8bcf03be4c995148e935dda3a23dac95e1972b41530ea4010deafeb
MD5 ae858db7a7e90da16cdef945105e9d2c
BLAKE2b-256 266c93b23280da7ff91a0c8fcbdedb39c7ff4886726dd980c97948b7212abf46

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bubbleid-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 34.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 717f3bff46ec320627907d65e635b243c56e074170b81fdfadabfd92ea6e013b
MD5 2cff12bb1304d5a01d86b401be03b057
BLAKE2b-256 04485a8029c1267bba3cf506ebdd81d42397be3a26e91313fab81ca0da6e45a0

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