Scripts Reference¶

milk includes shell scripts for common operations. Scripts are installed to bin/ alongside the compiled executables.

1. Core Scripts (`scripts/`)¶

Installed from the root CMakeLists.txt into bin/:

Script	Description
`milk-check`	Verify installation (libraries, paths, SHM)
`milk-check-standalone-deps`	Check standalone build dependencies
`milk-argparse`	Argument parsing helper for milk scripts
`milk-script-std-config`	Standard configuration for milk scripts
`milk-scriptexample`	Example/template for writing new scripts
`milk-script-advanced`	Advanced template combining bash & native milk-cli
`milk-exec`	Execute a milk CLI command non-interactively
`milk-cli-all`	Launch milk-cli on all accessible instances
`milk-commands`	List all available milk CLI commands
`milk-completion.sh`	Bash tab-completion for milk commands
`milk-fpsinit`	Initialize FPS instances from configuration
`milk-fpslist-addentry`	Add an entry to `fpslist.txt`
`milk-fpsmkcmd`	Generate FPS command scripts
`merge3DfitsTelemetry`	Merge 3D FITS telemetry cubes
`tmuxkillall`	Kill all tmux sessions
`tmuxsessionname`	Print the current tmux session name
`waitforfile`	Block until a specified file appears

2. Stream Utilities (`scripts/`)¶

Script	Description
`milk-FITS2shm`	Load a FITS file into shared memory
`milk-cubeslice2shm`	Extract a slice from a FITS cube into SHM
`milk-streamlink`	Create symbolic links to stream SHM files
`milk-shm2FITSloop`	Continuously save SHM stream to FITS files

3. Logging Scripts (`scripts/`)¶

Script	Description
`milk-logshim`	Start logging a stream to disk
`milk-logshimkill`	Kill a running log process
`milk-logshimon`	Enable logging for a stream
`milk-logshimoff`	Disable logging for a stream
`milk-logshimstat`	Show logging status

4. Image Utilities (`scripts/`)¶

Script	Description
`milk-cr2tofits`	Convert Canon RAW (CR2) files to FITS
`milk-fitsheader`	Display FITS file header
`milk-images-merge`	Merge multiple FITS images

5. FPS Scripts (`src/engine/libfps/scripts/`)¶

Script	Description
`milk-demopipeline`	Start a multi-stage FPS pipeline for demonstration
`milk-latency-audit`	Profile latency, cache misses, and IRQ affinities

6. milk-cli Script Payloads (`share/milk/scripts/`)¶

These are .milk files evaluated by the milk-cli interpreter. They are installed as data files (no execute bit) under share/milk/scripts/ and must be invoked via the CLI orchestrator:

milk-cli -s $(milk --install-prefix)/share/milk/scripts/makecircleofdisks.milk \
         [ndisks] [disk_radius] [circle_radius] [image_size] [output_name]

Script	Description
`makecircleofdisks.milk`	Generate a procedural ring of circular disks

7. COREMOD Scripts¶

7.1. COREMOD_memory (`src/coremods/COREMOD_memory/scripts/`)¶

Script	Description
`milk-semloopspeed`	Benchmark semaphore loop speed
`milk-shmimave`	Compute running average of a SHM stream
`milk-shmimcopy-semtrig`	Copy stream on semaphore trigger
`milk-shmimpoke`	Write test pattern to a SHM image
`milk-shmimpoke-semtrig`	Poke SHM image on semaphore trigger
`milk-streamFITSlog`	Log stream to FITS files with timestamps
`milk-nettransmit`	Transmit SHM stream over network

7.2. COREMOD_arith (`src/coremods/COREMOD_arith/scripts/`)¶

Script	Description
`milk-stream-crop`	Crop a sub-region from a stream
`milk-fpslistadd-SCICROPMASK`	Add science crop mask to FPS list
`milk-fpslistadd-WFSCROPMASK`	Add WFS crop mask to FPS list

7. Usage Examples¶

Loading a FITS file into shared memory¶

$ milk-FITS2shm myimage.fits mystream

This creates the shared memory stream mystream from the FITS file myimage.fits. Other processes can then connect to mystream via ImageStreamIO.

Benchmarking semaphore speed¶

$ milk-semloopspeed

Measures the round-trip semaphore post/wait latency. Typical values on modern hardware exceed 100 kHz.

Logging a stream to disk¶

# Start logging stream "wfs" to FITS files
$ milk-logshim wfs

# Check logging status
$ milk-logshimstat

# Stop logging
$ milk-logshimkill wfs

Streaming a FITS cube slice into shared memory¶

$ milk-cubeslice2shm mycube.fits 0 myslice

Extracts slice 0 from the FITS cube and writes it to the shared memory stream myslice.

← Documentation 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

Scripts Reference¶

1. Core Scripts (scripts/)¶

2. Stream Utilities (scripts/)¶

3. Logging Scripts (scripts/)¶

4. Image Utilities (scripts/)¶

5. FPS Scripts (src/engine/libfps/scripts/)¶

6. milk-cli Script Payloads (share/milk/scripts/)¶