Standalone Interactive HTML Movie (SIHM)

A highly-portable, interactive way to visualize your simulations.

Summary | Examples | Installation guide

Summary

This package provides sihm, a command-line tool that takes as input a YAML file that defines geometry and properties of that geometry—position, velocity, color, etc.—vs. time and turns it into a standalone, interactive HTML movie.

• The output is a movie in the sense that the trajectories vs. time are fixed. You'll be able to pause, play, rewind, loop, etc. as a movie would.
• The output is interactive because you can move the camera around while the video is playing (or paused). You can also "attach" the camera to an object and follow that object around the sim.
• The output is a standalone HTML file, i.e., it is the only file you will need to run the interactive movie.
• HTML was selected because it is extermely portable. The output should work anywhere: Linux, Mac, Windows, your cell phone, etc.

Examples

Examples of sihm's output can be found here.

Installation

Installing just the sihm Python package via pip install sihm will give you access to all the functionality of sihm (provided you install the system dependencies yourself). However, if you also want tab-completion for common shell programs such as bash or zsh, then you should consider installing the sihm package via your package manager (this will also take care of installing system dependencies so you don't have to worry about it yourself).

Linux

• Install the python package: pip install sihm
• Install the appropriate package—rpm or deb, depending on you OS— from the latest release.

Mac

• Install the python package: pip install sihm
• Download and install the brew package from the latest release, e.g., brew install sihm*.rb.

Windows

• Install the python package: pip install sihm
• Install the system dependencies
  • yarn
  • nodejs >= 16
  • cmake