Droplet-Film Model Development
Documentation
Installation Guide
System Requirements
Minimum
Recommended
Python Environment Setup
Step 1 — Install Python
Step 2 — Create Virtual Environment
Step 3 — Upgrade pip
Package Installation
Method 1: From repository (recommended)
Method 2: Manual install
Method 3: Requirements file
Verification
Step 1 — Test basic imports
Step 2 — Test project modules
Step 3 — Quick functionality test
Jupyter Notebooks
Step 1 — Install Jupyter
Step 2 — Launch and open notebooks
Data Preparation
Required CSV columns
Validate your data
Common Installation Issues
Permission errors
Version conflicts
Memory errors
Network / download failures
Compilation errors (Windows)
QLattice connection
Development Setup
Code quality and tests
IDE (VS Code)
Performance and Maintenance
Upgrade packages
Optional: Intel MKL
Backup and cleanup
Uninstall
Installation Checklist
Next Steps
Usage Examples and Tutorials
DFT Model Tutorial
DFT Implementation Overview
Basic DFT Setup
DFT Data Preparation
DFT Model Training
Making Predictions with DFT
Evaluating DFT Performance
Understanding DFT Output (Optional)
XGBoost Tutorial
XGBoost Implementation Overview
Basic XGBoost Setup
XGBoost Data Preparation
XGBoost Model Training
XGBoost Hyperparameter Tuning
XGBoost Feature Importance Analysis
PySINDy Tutorial
PySINDy Implementation Overview
PySINDy Setup and Installation
PySINDy Data Preparation
PySINDy Model Training
PySINDy Model Evaluation
PySR Tutorial
PySR Implementation Overview
PySR Setup and Installation
PySR Data Preparation
PySR Model Training
PySR Model Evaluation
QLattice Tutorial
QLattice Implementation Overview
QLattice Setup and Installation
QLattice Data Preparation
QLattice Model Training
QLattice Model Evaluation
Ensemble Methods Tutorial
Ensemble Implementation Overview
Ensemble Model Creation
Model Comparison
Advanced Usage Examples
Custom Alpha Strategy Implementation
Production Deployment Example
Batch Processing Example
Performance Optimization
Memory-Efficient Processing
Parallel Processing
API Reference
Overview
Core Classes and Modules
DFT Class — Core Physics Model
Class definition
Constructor
Methods — fit
Methods — predict
Methods — _eq (physics equation)
Methods — _loss
Helm Class — Data Management
Class definition
Constructor
Methods — evolv_model
QLatticeWrapper Class — Symbolic Regression
Constructor
Data Format Requirements
Data Validation, Error Handling, Performance
Support and Resources
Troubleshooting Guide
Droplet-Film Model Development
Index
Index