Skip to main content

simrun: simulation workflows on a k3s cluster

CI-CD Documentation Version Python Versions MIT License DOI

simrun runs simulation workflows on a small cluster of servers with k3s, Argo Workflows and Kueue. People and agents submit a workflow of tasks together with the working trees of their model and libraries, uncommitted changes included, and get a run id at once; the run is queued, placed, executed and recorded without the submitter staying connected.

Features include

  • workflows - YAML files of tasks of task types from plugins, which read the output ports of other tasks
  • split tasks - the units of a task (the repeats of a fit, the points of a scan) spread over the idle servers and are taken back by runs of a higher priority, with results which do not depend on the split
  • priorities - the owner of the cluster and the owner's agents first, then the other people, then their agents, with preemption by Kueue and reservations of nodes
  • learned resources - the memory of a pod is learned from earlier runs, a pod killed for memory is retried with more
  • snapshots and environments - the working trees are snapshotted into a shared run store, the third party dependencies are locked and built into an image only when they change
  • for people and agents - a command line, an HTTP API and an MCP server to submit, follow, compare and cancel runs
simrun submit fit.yaml --source model=~/git/pkdb_models --source sbmlsim=~/git/sbmlsim --group hctz
simrun wait <run>
simrun compare <run> <run>

Without a cluster the same workflow runs on this machine, with the web app, see local mode:

pip install simrun
simrun submit fit.yaml --source model=. --local
simrun outputs <run> <task> --to results

The documentation is available at https://matthiaskoenig.github.io/simrun: installation, concepts, workflows, command line, local mode, agents and MCP, plugins, service, cluster deployment and development.

If you have any questions or issues please open an issue.

Installation

pip install simrun

simrun needs python 3.14 or newer and runs on Linux, see Installation.

How to cite

If you use simrun please cite the archived software on Zenodo:

König, M. simrun: a runner of simulation workflows on a k3s cluster. Zenodo. https://doi.org/10.5281/zenodo.24035618

This DOI stands for every version of simrun; the DOI of a single version is on its Zenodo page. The metadata of the citation are in CITATION.cff.

License

simrun is licensed under the MIT License.

Funding

Matthias König is supported by the Federal Ministry of Education and Research (BMBF, Germany) within the research network Systems Medicine of the Liver (LiSyM, grant number 031L0054) and by the German Research Foundation (DFG) within the Research Unit Programme FOR 5151 QuaLiPerF (Quantifying Liver Perfusion-Function Relationship in Complex Resection - A Systems Medicine Approach) by grant number 436883643 and by grant number 465194077 (Priority Programme SPP 2311, Subproject SimLivA). Matthias König has received funds from the EOSCsecretariat.eu which has received funding from the European Union's Horizon Programme call H2020-INFRAEOSC-05-2018-2019, grant Agreement number 831644.

© 2026 Matthias König

Metadata

Release files for simrun 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for simrun 0.3.1
File Size Uploaded Provenance Actions
simrun-0.3.1.tar.gz 3.8 MB With provenance Details for simrun-0.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for simrun 0.3.1
File Interpreter ABI Platform Actions
simrun-0.3.1-py3-none-any.whl Python 3 none any Details for simrun-0.3.1-py3-none-any.whl

Total release size: 4.1 MB

Release files / simrun-0.3.1.tar.gz

Download URL simrun-0.3.1.tar.gz
Size 3.8 MB
Tags Source
SHA-256 checksum
How to use checksums
95407dab33326a8f4d6ff4737f848b0d5e6fd9769b04d136a31dbbc12a4ea5bb
BLAKE2b-256 checksum
How to use checksums
686645fecb751065fa6faac645ca83380119aa3a17810e10030471497347bf5d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Release files / simrun-0.3.1-py3-none-any.whl

Download URL simrun-0.3.1-py3-none-any.whl
Size 330.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d0ae5505447ef3f864bf3e50254d5807c292c35c916a5f45f841148de4071b96
BLAKE2b-256 checksum
How to use checksums
63e75d3bf63c5de9334fded7119dba16630896d720a1ed58896338d0224e7c50
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Security for simrun 0.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for simrun-0.3.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page