sim-plugin-starccm

Simcenter STAR-CCM+ driver for sim-cli, distributed as an out-of-tree plugin via Python entry_points.

STAR-CCM+ has no pip-installable Python SDK. Scripts are Java macros (.java files extending StarMacro) executed through starccm+ -batch. The user must install and license STAR-CCM+ separately. See LICENSE-NOTICE.md.

Install

pip install git+https://github.com/svd-ai-lab/sim-plugin-starccm@main

After install, sim-cli auto-discovers the driver:

sim drivers | grep starccm
sim run --solver starccm path/to/macro.java

How it works

The plugin registers via two entry-point groups:

[project.entry-points."sim.drivers"]
starccm = "sim_plugin_starccm:StarccmDriver"

[project.entry-points."sim.skills"]
starccm = "sim_plugin_starccm:skills_dir"

sim.drivers exposes the driver class; sim.skills exposes a directory of skill files bundled inside the wheel.

Supported versions

See src/sim_plugin_starccm/compatibility.yaml for the solver compatibility matrix. Current profile covers STAR-CCM+ 21.02 (a.k.a. 2602).

Develop

git clone https://github.com/svd-ai-lab/sim-plugin-starccm
cd sim-plugin-starccm
uv sync
uv run pytest

End-to-end tests require a real STAR-CCM+ install on the host; they're gated and skipped when the solver is not detected.

License

Apache-2.0. See LICENSE and LICENSE-NOTICE.md.