You are viewing the documentation for Deformable v0.7.0, an older version. Read the latest, v0.9.0
Python SDK
Getting started with Python
Install the deformable package with pip and run your first simulation from Python.
On this page
The Python SDK brings the Tangerina Deformable engine into your own Python tools. It is the package deformable,
pure Python over libdeformable, the shared library of the C SDK, and it calls the library with ctypes. It has no
third-party dependency, and you need no compiler to install it: the wheel for your platform carries the library.
The package exposes the same scene, mesh tools and render surfaces as the C and Rust SDKs, with Python names and Python types. What they do, and why, is in the Engine guide, starting with How the engine works; this guide shows how to use them from Python.
Requirements
- Python 3.9 or later.
- macOS 11 or later on Apple silicon, Linux x64 with glibc 2.28 or later, or Windows x64.
Install
Install the package from PyPI with pip, preferably in a virtual environment:
pip install deformableOr add it to a uv project:
uv add deformablepip picks the wheel for your platform, such as deformable-0.1.0-py3-none-macosx_11_0_arm64.whl. The wheel holds the
package and libdeformable inside it, so nothing else needs installing.
Check the installation
import deformable
print(deformable.__version__, deformable.library_version())0.1.0 0.1.0deformable.__version__ is the package version. deformable.library_version() asks the loaded library for its
version, as major.minor.patch. The two match when the package and the library come from the same release.
Your first simulation
This script builds a closed unit cube, fills it with tetrahedrons, and lets it fall under gravity for one second.
Save it as falling_cube.py, then run it with python falling_cube.py.
import deformable
# A closed unit cube: 8 corners and 12 outward triangles.
positions = [(x, y, z) for z in (0.0, 1.0) for y in (0.0, 1.0) for x in (0.0, 1.0)]
triangles = [
(0, 2, 3), (0, 3, 1), (4, 5, 7), (4, 7, 6), (0, 1, 5), (0, 5, 4),
(2, 6, 7), (2, 7, 3), (0, 4, 6), (0, 6, 2), (1, 3, 7), (1, 7, 5),
]
cage = deformable.TriangleMesh(positions, triangles)
# Fill the cage with tetrahedrons.
mesh = deformable.tetrahedralize(cage, deformable.TetrahedralizeParameters(maximum_edge_length=0.5)).mesh
with deformable.Scene() as scene:
material = scene.add_material(deformable.MaterialParameters.default())
cube = scene.add_object(mesh, material)
# 24 frames per second, 10 substeps per frame. The first call only records the time.
for frame in range(25):
scene.step(frame / 24, substeps=10)
positions = scene.node_positions(cube)
lowest = min(position.y for position in positions)
print(f"{len(positions)} nodes, lowest at y = {lowest:.2f}")9 nodes, lowest at y = -4.93Each step does this:
tetrahedralizeturns the closed triangle cage into aTetrahedralMesh.Scene()creates an empty scene with gravity (0, -9.81, 0). Thewithblock frees it at the end.add_materialreturns a material handle, andadd_objectreturns an object handle. Both are plainintvalues.step(time, substeps)advances the scene totime, in seconds. The first call only records the start time.node_positionscopies the current node positions into a list ofVector3.
The cube falls about 4.9 units in one second, as free fall predicts. Nothing stops it, because the scene has no floor. Scene shows how to add one.
License
The package works with Free, the Standalone subscription, and the Standalone and Application licenses. Without a sign-in or a key, it runs as Free, forever: every feature, up to 2,500 tetrahedrons per scene, with no account and no internet, and nothing is sent. A Standalone subscription or a Standalone license lifts the limit on your device. Sign in to the subscription once, in the browser, and the library checks it in by itself while the script runs online, at least once a day. Or activate a Standalone license key once, online, and the library renews it by itself, at least once every 7 days. Either one is shared with the plugins and the other SDKs on the same device. An app you ship to others uses an Application license instead: it activates the Application key at every start, offline, as its first Deformable call, before any engine call. Licensing has the whole story.
deformable.license reads and changes the license state. This script renews the Standalone subscription or license
when that is due, and prints the status line:
import deformable
print(deformable.license.refresh().message)Free: up to 2,500 tetrahedrons per scene| Function | What it does |
|---|---|
status() |
Returns a License: the state, days_ (of an Application trial), tetrahedron_ (2500 on Free, None without a limit), has_, signed_ (True while a Standalone subscription is signed in on this device), the signed-in account’s email and the status line message. It never goes online. |
refresh(timeout=15.0) |
Renews the Standalone license, or checks in the Standalone subscription, when that is due. Call it when your tool starts. On Free, and under an Application license, it contacts nothing. |
start_ |
Starts a sign-in with a Standalone subscription. Returns a Sign: the user_ to approve, the verification_ of the page that approves it, and expires_, how many seconds the code lasts. Show both to the user, or open the address in the browser. |
wait_ |
Waits for the approval, for at most the timeout. Returns the License once the account approved it: in STANDALONE_ when a seat was free, otherwise in a state that says why there is none, such as SUBSCRIPTION_, where take_ moves the seat here; or None while not yet: call it again. It can return up to 25 seconds after its timeout, so call it off your interface thread. |
take_ |
Moves the subscription’s seat to this device from the device that uses it. |
sign_ |
Forgets the sign-in on this device at once, even offline, and frees its seat when the device is online. |
activate(license_ |
Turns a license key on. A Standalone key, such as "tgdfp-xxxxx-xxxxx-xxxxx-xxxxx", is activated on this device and needs internet. An Application key, "tgdfp-<payload hex>-<signature hex>", is checked offline and holds for this run of the program, so call it at every start. |
deactivate(timeout=15.0) |
Forgets the Standalone license on this device at once, even offline, and frees its seat when the device is online. |
set_ |
With False, keeps the script off the network: nothing is sent, and a subscription or a Standalone license runs only as long as it runs offline. |
The state is a deformable.LicenseState, such as FREE, STANDALONE_SUBSCRIPTION, STANDALONE_LICENSE or
APPLICATION_LICENSE. SUBSCRIPTION_NEEDS_ONLINE, SUBSCRIPTION_NO_SEAT (another device uses the seat, or this one
was removed), NO_SUBSCRIPTION, SIGN_IN_ENDED, LICENSE_NEEDS_ONLINE (a Standalone license that needs a renewal)
and APPLICATION_TRIAL_ENDED run as Free, with its limit.
A sign-in shows a code and waits until the user approves it in the browser:
import deformable
sign_in = deformable.license.start_sign_in()
print(f"Open {sign_in.verification_url} and approve the code {sign_in.user_code}")
status = None
while status is None:
status = deformable.license.wait_for_sign_in(timeout=5)
print(status.message)Open https://platform.tangerina.io/device?user_code=ABCDEFGH and approve the code ABCD-EFGH
Standalone subscriptionWhen the code ends or the user denies it, the wait raises a LicenseError with the status LICENSE_SIGN_IN_FAILED,
and its message says why.
The timeouts are in seconds. On Free, Scene.add_object raises TetrahedronLimitExceededError, a LicenseError, for
an object that would take the scene past the limit, with a message such as Free: this would simulate 3,120
tetrahedrons; the limit is 2,500 per scene. See
Types and errors.
A Standalone subscription or license belongs to each device that runs the script. On a colleague’s device, a server or a render farm node, the script runs as Free, up to 2,500 tetrahedrons per scene, unless that device has its own seat. To ship the engine inside an app you give to others, you need an Application license: your app then activates its key at every start, offline, and its users need no activation, network or seat. See Application license.
How the package finds the library
The package loads the library on the first call that needs it, once per process. It looks in three places, in this order, and loads the first file it finds:
- The file named by the
DEFORMABLE_LIBRARYenvironment variable. A path that is not a file is skipped. - The package folder,
deformable/, next to__init__.py. The wheel carries the library here. target/releaseof the source tree the package sits in, which only a contributor’s checkout of the product has.
If no place holds the library, the call raises deformable.LibraryNotFoundError, a subclass of OSError. Its
message lists every path it searched. Importing the package never loads the library, so the import itself does not
fail.
To use another copy of the library, for example one from the C SDK,
point DEFORMABLE_LIBRARY at the file:
export DEFORMABLE_LIBRARY=/opt/deformable/lib/libdeformable.soInside Blender. Blender’s bundled Python is newer than 3.9, so the package runs there too. Install it into Blender’s Python, or put it on Blender’s module path. You do not need this to use the Blender plugin: the plugin carries its own copy.
Conventions
These rules hold for the whole package. Types and errors covers them in full.
- Errors. A failed library call raises
DeformableError, with the status, the message and the indices of the element it concerns. An argument the package refuses before it calls the library raisesValueErrororTypeError. - Arrays. Inputs can be lists or tuples of groups, flat sequences of numbers,
array.array,memoryviewor any other buffer. Results are lists ofVector3and of index tuples. - Handles.
Scene,SurfaceEmbeddingandCancelFlagown a library handle. Use them in awithblock or callclose(). Object and material handles areintvalues that count up from 0. - Units. Lengths cross in host units. Time, forces, gravity, masses and material values are in simulation units. The scene’s scale converts host lengths to simulation lengths.
- License. On Free, a scene simulates up to 2,500 tetrahedrons, and
Scene.add_objectraisesTetrahedronLimitExceededErrorfor an object past the limit.deformable.licensereads and changes the license. - Threads. Library calls release the global interpreter lock. Calls on one scene run one at a time. Tools, embeddings and cancel flags work from several threads at once.
Next steps
- How the engine works: the ideas the plugins and every SDK share, explained once in the Engine guide.
- Scene: materials, objects, driving, glue, stepping and outputs.
- Tools: the mesh tools that prepare a scene’s inputs.
- Render surfaces: skin a render mesh on a simulated object.
- Types and errors: array forms, handles, errors, threads and units.
- Python API reference: every class, function and field of the package.