Find your way around the platform¶
Start with Platform: the single composition entry for opening research workspaces and prepared experiments. User Agent code imports sim_platform.sdk.
Choose a folder by the responsibility you want to change:
| I want to change… | Start here |
|---|---|
| Import/check saved Agent source | agents/projects |
| Agent Python selection/download/import | agents/runtimes |
| Preparation job/subprocess lifecycle | agents/preparation |
| Dependency environment preparation | agents/environments |
| Agent project/environment storage | persistence/agents |
| Public experiment setup and resource ownership | application/platform.py |
| How Platform connects experiment components | application/experiments |
| Preparing choices, loading data, controlling an experiment | research |
| Human or Rule decisions, in Controlled or Live mode | decisions/policy |
| The Agent runner that connects the platform to an Agent | decisions/agent |
| Work wakeups, waiting, model timeout or retry policy | experiments/scheduling |
| Ordering market events and commands, execution controls, result delivery | experiments/execution |
| Starting, communicating with or stopping the Agent process | agents/hosting |
| Agent loop, prompt, conversation or model adapter | agents/carrier |
| Platform tool proxies, routing or result formatting | agents/tools |
| Financial validation, reservations, orders and fills | execution |
| Historical input, preparation or time-limited market queries | market |
| Accounts, ledger values and pure domain rules | domain |
| Database transactions, repositories or file storage | persistence |
| Screens and widgets | desktop |
| CLI commands | cli |
Folders describe functions, not running processes. A host.py controls a child from
the App; worker.py or process.py contains its child entrypoint; client.py
contains a caller-side capability. A runner or controller is an object, not a thread.
Each process-owning package documents which side executes each file.
For setup and execution flow, read architecture. Processes and threads identifies the running entrypoints; lifecycle identifies resource owners. Use the code map to plan a change and verification to choose its checks.
Tests live in tests/platform. Runnable examples live in examples and external Agent examples.