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.
- 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:
Training your own model:
- Annotate image data, Lableme was used for our dataset.
- Convert labelme dataset to yolo format
- Run training
- See Using the BubbleID Framework but use your new model weights
Metadata
Release files for bubbleid 0.0.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bubbleid-0.0.9.tar.gz | 37.6 kB | Without provenance | Details for bubbleid-0.0.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bubbleid-0.0.9-py3-none-any.whl | Python 3 | none | any | Details for bubbleid-0.0.9-py3-none-any.whl |
Total release size: 76.4 kB
Release files / bubbleid-0.0.9.tar.gz
| Download URL | bubbleid-0.0.9.tar.gz |
|---|---|
| Size | 37.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9193287ddd90401ffa93ecda7d7103cad7df0feb1dc06845922d82e750330f6d
|
|
BLAKE2b-256 checksum How to use checksums |
92e34caf78cb418737ac85a745c992e51f29838e96bf5d278244c5773d683419
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.10.16
|
Release files / bubbleid-0.0.9-py3-none-any.whl
| Download URL | bubbleid-0.0.9-py3-none-any.whl |
|---|---|
| Size | 38.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6ac6dc7817705d5bb9d8fca374dd73f1488a80d664d57cc6aa139db102a0d68c
|
|
BLAKE2b-256 checksum How to use checksums |
9418b6c575ed63ba5c8e0844db7946c4480f9ae51b6a088c03dbff2e8196a4d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.10.16
|
Security for bubbleid 0.0.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.