API reference¶
The API reference is generated from the docstrings of the package.
simrun¶
The workflows, the plugins, the clients, the planning and the harness of the pods.
| module | description |
|---|---|
| workflow | the workflow model: tasks, the references between them and their order |
| plugins | the plugin interface: task types, their resource hints and their discovery |
| plugins_builtin | the built-in task types |
| demo | the demo plugin: sums of squares, split into one unit per number |
| client | the client of the service: snapshots working trees, then calls the API |
| cli | the command line of simrun: submit, follow and compare runs |
| local | the local service of a project in .simrun/, started on demand |
| mcp | the MCP server of simrun, a local stdio process of an agent |
| planner | the planner: the shape of a worker pod and the number of pieces of a task |
| resources | resources learned from the reports of workers |
| ledger | the unit ledger: workers of a split task claim units through atomic renames |
| worker | the worker harness: a pod of a split task computes units of the ledger in a pool |
| cgroup | the limits and the usage of the cgroup (v2) a worker runs in |
| snapshot | snapshots of working trees with provenance |
| environment | the environment of a run: a lock from the model and its snapshotted libraries |
| store | the run store: run records and the layout of a run on the shared drive |
| config | the configuration of the cluster the runs are submitted to |
| podspec | the parts of a pod which every backend shares: image, shapes, command, environment |
| argo | Argo workflows from runs: one DAG, a scatter of workers per split task |
| cwl | CWL v1.2 workflows from runs, executed with cwltool (or Toil on Slurm) |
| testing | a backend in memory for tests of the service, advanced by the test |
simrun.service¶
The service: the API, the controller and the backends, see Service.
| module | description |
|---|---|
| service.app | the API of the service: people and agents submit, follow and compare runs |
| service.auth | identities of the callers of the service and the priorities of their runs |
| service.backend | the backend the service runs workflows on: Argo Workflows, or a fake in tests |
| service.argo_backend | the backend of the service on a cluster: Argo Workflows, Kueue and BuildKit |
| service.local_backend | the backend of the local mode: the tasks of a run as processes on this machine |
| service.local_env | the venv of a local run with snapshots, never the environment of the service |
| service.controller | the controller: follows the workflows of the runs and records their end |
| service.submission | the submission of a run in the background: its environment, image and workflow |
| service.index | the index of the runs in SQLite, beside the run store |
| service.logs | the logs of the pods of a task, kept in the run store |
| service.compare | the comparison of runs: provenance and the summaries of their tasks side by side |