Get started

1. Install

Get the Apache-2.0 Python SDK, and a solver binary if you want to run locally.

Install the SDK

2. Quickstart

Build a scene, price it, run it, read the results.

Quickstart

3. Pick a path

Scripts and notebooks, or the desktop application.

Headless · Desktop app

Which path is yours

You want to…	Use	Page
Drive runs from Python scripts, notebooks, or SSH	SDK + phsolver	Headless solver
Work in a GUI with plots and project files	PhotonHub desktop app	Desktop app
Build a scene without running anything	SDK alone	Quickstart
Run on a remote GPU	SDK + ph.cloud	Cloud GPU runs

The SDK alone is enough to build, validate, and price a simulation. You only need a solver to execute one.

Requirements

• Python 3.11 or newer. The SDK is pure Python; its dependencies are pydantic, numpy, scipy, xarray, matplotlib, and certifi.
• A solver binary for local runs. See Install.
• Nothing else for cost estimation, schema validation, mode solving, or building geometry: those are all pure Python.

Before interpreting results, read Known limitations. For recovery, use Troubleshooting or contact beta@leapfield.ai.