Installation¶
simrun needs python 3.14 or newer and runs on Linux. The same package is the client (the command line simrun and the MCP server simrun-mcp), the service and the harness of the pods (simrun-worker, simrun-merge, simrun-exec). Install it from PyPI with pip:
With uv¶
With uv, install the command line as a tool:
add simrun to a project, e.g. the one of a plugin, which locks it together with the rest of the environment:
or run it from a checkout of the repository, which is how the MCP server of an agent is usually registered (see Agents and MCP):
Check the installation¶
The command line needs a running service, see Command line, or runs everything on this machine with --local, see Local mode; the service and the cluster are set up as described in Cluster deployment.
Optional packages¶
| feature | install |
|---|---|
the CWL export of a run (simrun.cwl), validated with cwl-utils and run with cwltool, locally or on Slurm |
pip install "simrun[cwl]" |
| the tools of development: tests, lint, types, documentation, release | pip install "simrun[dev]", see Development |