Get started

Point your agent at this page. It does the setup.

Setup is a virtual environment, one browser sign-in and two installs. It is the first thing worth handing over: the steps are written down, the agent reads them and runs them, and every step has a check that says whether it worked.

Paste this into an agent opened on an empty local folder. You approve each command as it goes.

Hand this to your agent

Read the Get started page at toolkit.simcon.ai and set up the Cadmould API Toolkit in this folder the way it describes. Work through the steps in order, run the verify check after each one, and show me each command before you run it. Stop and ask me if a step needs a decision I have to make.

Not running an agent yet? Start with working with agents · it takes an afternoon and this page is waiting afterwards.

What it will run

The same steps, for reading along or running yourself. The sign-in opens a browser once and points this environment’s pip at the licensed wheel.

macOS · Linux

$ python3 -m venv .venv$ source .venv/bin/activate$ pip install --upgrade pip cadmould-sdk-auth$ cadmould-sdk-auth$ pip install ".[examples]"

Windows · PowerShell

$ py -m venv .venv$ .\.venv\Scripts\python.exe -m pip install --upgrade pip cadmould-sdk-auth$ $env:VIRTUAL_ENV = "$PWD\.venv"$ .\.venv\Scripts\cadmould-sdk-auth.exe$ .\.venv\Scripts\python.exe -m pip install ".[examples]"

Then verify

$ python -c "import cadmould; print('cadmould', cadmould.__version__)"

$ .\.venv\Scripts\python.exe -c "import cadmould; print('cadmould', cadmould.__version__)"

The index token is short-lived. If a later install fails with an auth error, run cadmould-sdk-auth again and retry.

Install only what one example needs

The last install pulls everything the three examples need. Swap the extra to take only one.

pip install ".[examples]"Everything the three examples need, in one shot

pip install ".[result-viewer]"The offline viewer · matplotlib and pyvista

pip install ".[cloud-quickstart]"One filling run through the SDK · pyvista

pip install ".[gate-study]"The full study · adds httpx and python-pptx

Using uv instead of pip

uv works too, with one wrinkle · cadmould-sdk-auth writes the index URL into pip’s config, which uv ignores. Pass it across explicitly with cadmould-sdk-auth --print-index-url.

Before you start

Python 3.9 to 3.14Wheels are published for CPython 3.9 through 3.14 on Windows x64, macOS on Apple Silicon and Linux x86_64.

A Simcon accountSign-in authenticates against Simcon · either an @simcon.com or a customer account.

A browser on this machineSign-in is a PKCE browser flow, so it cannot run headless, over SSH or in CI.

A Cadmould licenceNeeded to run the SDK locally and to reach the cloud, which checks the LICENCE_API entitlement.

A local folder, not a synced oneA virtual environment is thousands of small, frequently locked files. Inside OneDrive or Dropbox that means conflicts and flaky installs.

On Windows, Python from python.orgThe Microsoft Store build routinely breaks venv creation and the py launcher. On macOS the Thales Sentinel LDK run-time is needed for licensing.

Two logins, not one

Install authcadmould-sdk-authThe licensed cadmould wheel from Simcon’s private index. It only configures pip · nothing else.

Cloud accesscadmould.cloudThe right to run simulations and manage data. The SDK opens the browser flow on first call, or bring your own client over REST with a bearer token.

If pip cannot find the package it is the first. If the import works but calls come back 401, it is the second.

Platform calls and local meshing run inside a licence session · one Session.user_based() around the whole script. Rule: never nest them · an inner session releases the licence when it exits.

Units across the API · temperature K · pressure Pa · spatial mm · flow cm³/s

Then hand it the first example

The offline result viewer needs no cloud call and no licence · a finished result and its geometry ship inside it.

Start offline Browse the recipes