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.5.tar.gz (37.4 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.5-py3-none-any.whl (38.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bubbleid-0.0.5.tar.gz
  • Upload date:
  • Size: 37.4 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.5.tar.gz
Algorithm Hash digest
SHA256 6e03035cc7609d7b70bff8431653f1e2afc97c071751391f0ae07053291d166c
MD5 3ec0d2309cf42c35f3bf00ed8d0ace0f
BLAKE2b-256 46af244498b0b0add553afa9fad40e51a069dd53a972e4e1413caa9c3c1c25b6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bubbleid-0.0.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8f07dbf2176b27059fdba120df30a052a973b928a1a1054810dffbf38b5182f5
MD5 c36d98a3cf38b3357ef298086f1ffd50
BLAKE2b-256 eea4e35c342c2e147620ede18867baceca4665eabb1baa38d5b24bafa08520b9

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