Dimmara developer documentation
Python API¶
Build models. Run simulations. Work with results. Connect your Python workflow to Dimmara, or use the modeling engine locally.
One client. Your modeling workflow.¶
from sysml_studio import Client
# Reads SYSML_STUDIO_API_KEY from your environment.
with Client("https://api.dimmara.com") as studio:
access = studio.check_access()
print(access)
Use the Python client to save linked models, validate revisions, run remote jobs and retrieve results. Use the local engine to run the same supported behavior profile without a server. These are separate installable distributions:
Distribution |
Import |
Purpose |
|---|---|---|
|
|
Authenticated Studio HTTP client; no local Java or simulation engine required. |
|
|
Local model resolution, typed Python authoring, units and simulation. |
Start with Install and run your first model, then use Linked models, jobs and results for dependency pins, input signals and background jobs. The Client API reference and Local engine reference pages read signatures and documentation directly from Python source at build time. Examples on Executable local examples are executed during the documentation build checks.
The engine implements a bounded SysML profile. See the repository’s language contract for supported constructs and current limits. Reference checks use the pinned 2024-07 SysML pilot compiler; executable-profile support is checked separately.