animate
Create animations from time series simulation data or camera orbits with configurable speed, timing, and output formats including MP4, WebM, and GIF.
Instructions
Create an animation from time series data or camera orbit.
Time mapping (timesteps mode): speed_factor=1.0: real-time (physics 1s = video 1s) speed_factor=5.0: 5x fast-forward speed_factor=0.2: 5x slow-motion (physics 1s = video 5s)
For VTK file series (e.g., PartFluid_0000.vtk through PartFluid_0100.vtk), use 'files' with an explicit list or 'file_pattern' with a glob pattern.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file_path | Yes | Path to simulation file (or first file in series) | |
| field_name | Yes | Field to visualize | |
| mode | No | "timesteps" for time series, "orbit" for camera rotation | timesteps |
| colormap | No | Color map preset | Cool to Warm |
| camera | No | Camera preset (used for initial view in orbit mode) | isometric |
| fps | No | Frames per second (15-60) | |
| time_range | No | [start, end] physics time range, None for all | |
| speed_factor | No | Playback speed multiplier (1.0=real-time) | |
| orbit_duration | No | Orbit video length in seconds (orbit mode only) | |
| width | No | Frame width | |
| height | No | Frame height | |
| files | No | Explicit list of file paths for VTK time series | |
| file_pattern | No | Glob pattern for file series (e.g., "/data/PartFluid_*.vtk") | |
| output_format | No | Output format — "frames" (PNG only), "mp4", "webm", or "gif" | frames |
| video_quality | No | Video CRF quality (lower=better, 18-28 typical, default 23) | |
| text_overlay | No | Text to overlay on video frames (e.g., case name) |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||