Python SDK Reference

A zero-dependency client (`pip install flowsim-sdk`, standard library only) wrapping the same REST API the app itself uses — build flowsheets, run/poll solves, and fetch stream/cost/sustainability results.

sdkpython

Concept

A zero-dependency client (standard library urllib only — no numpy/scipy/ solver stack) wrapping the same REST API the app itself uses. Every method is a thin wrapper; nothing the SDK does is a special, less-capable path.

Execution

Coverage

client = FlowSimClient("https://maximalabs.io")

# simulate & analyze
client.create_simulation(name, flowsheet); client.run(sim_id); client.wait(sim_id)
client.streams(sim_id); client.cost(sim_id); client.sustainability(sim_id)
client.hx_rating(sim_id); client.safety(sim_id); client.datasheet(sim_id)
client.optimize(sim_id, spec); client.sensitivity(sim_id, spec)

# collaborate & organize
client.save_snapshot(sim_id); client.restore_snapshot(sim_id, snap_id)
client.add_collaborator(sim_id, email); client.create_project(name)

# digital twin
client.twin(sim_id); client.twin_history(sim_id, tag); client.add_twin_readings(sim_id, readings)

flowsim.sdk.batch.run_batch is a separate, headless runner for ML/RTO pipelines — it calls the pure solver directly (in-process, needs numpy/scipy/ CoolProp) rather than going over HTTP, for when you're generating thousands of runs for a sensitivity study or synthetic training data.