Code Examples

These examples intentionally use real file paths and workflows you can run locally.

0) Sanity-check: server is reachable

curl -fsS http://localhost:8000/ | head

1) Load a model + create an instance (spx-python)

python - <<'PY'
import os
import yaml
import spx_python

client = spx_python.init(
    address=os.environ.get("SPX_BASE_URL", "http://localhost:8000"),
    product_key=os.environ["SPX_PRODUCT_KEY"],
)

with open("model.yaml", "r", encoding="utf-8") as f:
    model_def = yaml.safe_load(f)

client["models"]["MyModel"] = model_def
client["instances"]["my_inst"] = "MyModel"

client.prepare()
client["instances"]["my_inst"]["timer"]["time"] = 1.0
client.run()

print("OK: instance stepped to t=1.0s")
PY

2) Inspect an instance tree (spx-python)

python - <<'PY'
import os
import spx_python

client = spx_python.init(
    address=os.environ.get("SPX_BASE_URL", "http://localhost:8000"),
    product_key=os.environ["SPX_PRODUCT_KEY"],
)

inst = client["instances"]["my_inst"]
print("attributes:", list(inst.get("attributes", {}).keys()))
print("timer:", inst.get("timer", {}))
PY

3) Where to find endpoint details

• Use the embedded OpenAPI reference in this chapter to discover exact paths, payloads, and auth requirements.

• For logs-related endpoints, see Logs.