Skip to content
Home/Developers/Quickstart

5-minute quickstart

Install the iEDA Agent SDK, call your first tool, inspect results.

iMapsynthesisiFPfloorplaniPDNpoweriPLplacementiCTSclockiTOoptimizationiRTroutingiSTAtimingAiEDAdesign dataiPCLlayout modeliMapsynthesisiFPfloorplaniPDNpoweriPLplacementiCTSclockiTOoptimizationiRTroutingiSTAtimingAiEDAdesign dataiPCLlayout model

Step 1: Install the SDK

pip install ieda-agent-sdk

Step 2: Initialize the client

from ieda import AgentClient

client = AgentClient(
    base_url="http://localhost:8080",  # iEDA Platform address
    api_key="your-api-key"              # or read from IEDA_API_KEY env var
)

Step 3: Load design

design = client.load_design(
    name="gcd",
    tech="sky130",
    sources=["gcd.v", "gcd.sdc"]
)

print(f"Loaded: {design.stats.cells} cells, {design.stats.nets} nets")

Step 4: Invoke placement tool

result = client.call(
    "iPL.place",
    design_ref=design.snapshot_id,
    effort="standard"
)

print(f"Placement done: HPWL={result.hpwl}, Density={result.density:.2%}")

Step 5: Invoke timing analysis

timing = client.call(
    "iSTA.analyze",
    design_ref=result.design_ref,
    scenarios=["func_typical", "func_worst"]
)

print(f"WNS: {timing.wns}ns, TNS: {timing.tns}ns, Failing: {timing.failing_paths}")

Next Steps

Environment setup

  • iEDA Platform running (Docker or native build)
  • Python 3.10+
  • Process library ready (sky130 included with demo)

Ready?

Dive into API reference for full endpoint and parameter documentation.