milk¶
High-performance real-time image processing framework for Adaptive Optics and scientific computing. Microsecond-latency pipelines through zero-copy shared memory.
milk orchestrates many small compute units that communicate through zero-copy shared memory tensors, enabling microsecond-latency data pipelines. The three pillars — ImageStreamIO, FPS, and processinfo — live entirely in /dev/shm/.
Getting Started¶
- Install
Clone, build, and configure the milk framework.
- Build Tiers
Engine → Core → Full: compile only what you need.
- CLI Overview
Interactive shell, standalone executables, and scripting basics.
- FAQ
Common issues with builds, SHM, FPS, and CLI.
Core Concepts¶
- Streams
Zero-copy shared memory tensors (ImageStreamIO).
- FPS
Live parameter sync, state control, TUI dashboards.
- Process Info
Heartbeat telemetry, loop-rate profiling, health monitoring.
- Architecture
System overview, layered design, data flow diagrams.
Developer Guides¶
- Tutorial
Write your first compute module step by step.
- Coding Standards
C style, line length, includes, Kernel-Doc.
- Adding Plugins
Build modules that compile alongside the core.
- Template Code
Breakdown of milk_module_example.
Operations & Reference¶
- Performance
CPU pinning, RT scheduling, SIMD, BLAS, GPU.
- PGO & LTO
Profile-guided optimization + static link-time optimization for 15–40 % speedup.
- Debugging
GDB, tmux logs, procinfo diagnostics, common failures.
More Resources¶
- What's New — recent features and upgrades
- CLI Syntax Reference · Readline Keys
- Scripts Reference · Python API · Valkey Integration
- Programmer's Guide · Dependency Graph · fpsCTRL Reference
- Working with Git · Code Assist Tools
- All Markdown Files · Tag Index
[FPS]: Function Processing System — shared-memory parameter management [SHM]: Shared Memory (/dev/shm) [AO]: Adaptive Optics [TUI]: Text User Interface (ANSI escape sequences) [CLI]: Command Line Interface [IMGID]: Image ID — milk's stream reference structure [LTO]: Link-Time Optimization [PGO]: Profile-Guided Optimization [RT]: Real-Time (scheduling) [DM]: Deformable Mirror [WFS]: Wavefront Sensor [FITS]: Flexible Image Transport System *[IPC]: Inter-Process Communication