Examples & recipes

import os
from cufemlab_client import Client

client = Client(api_key=os.environ["CUFEMLAB_API_KEY"])   # base url defaults to https://app.cufemlab.secrotec.nl
project = client.create_project("PMSM cogging (moving band)")

# Moving-band cogging is parametric - no geometry upload needed.
job = client.analyze(
    project_id=project.id,
    analysis_type="cogging_torque_movingband",
    input_params={"n_poles": 4, "n_slots": 12, "Br_T": 1.20, "n_angles": 24, "refine_levels": 3},
    gpu=True,
)
job.wait(poll_interval=10)
result = job.result()

print(result.verdict, result.value)     # PASS + peak cogging amplitude (N·m)
print(result.metrics)                   # FEMM/GetDP validation card: tolerance + measured error

import os
from cufemlab_client import Client

client = Client(api_key=os.environ["CUFEMLAB_API_KEY"])
project = client.create_project("Cogging sweep (legacy 2-D)")

job = client.analyze(
    project_id=project.id,
    analysis_type="cogging_sweep_2d",
    input_params={"n_angles": 32, "Br_T": 1.20},
    gpu=True,
)
job.wait(poll_interval=10)
result = job.result()
print(result.verdict, result.summary)   # .summary is a dict property, not a method

import os
from cufemlab_client import Client

client = Client(api_key=os.environ["CUFEMLAB_API_KEY"])
project = client.create_project("PMSM operating torque")

geom = client.upload_file(project.id, "pmsm_2d.step")

job = client.analyze(
    project_id=project.id,
    analysis_type="pmsm_operating_torque",
    input_params={"current_a": 12.0, "rpm": 3000, "advance_deg": 15.0},
    input_file_ids=[geom.id],
    gpu=True,
)
job.wait(poll_interval=10)
result = job.result()
print(result.verdict, result.value)     # operating-torque ENGINEERING ESTIMATE (N·m)

import os
from cufemlab_client import Client

client = Client(api_key=os.environ["CUFEMLAB_API_KEY"])
project = client.create_project("Iron-loss study")

job = client.analyze(
    project_id=project.id,
    analysis_type="iron_loss_estimate",
    input_params={"rpm": 3000, "B_peak_T": 1.4, "material": "M250-35A"},
)
job.wait(poll_interval=10)
res = job.result()
print(f"iron loss = {res.value} W   metrics = {res.metrics}")   # estimate, watts

import os
from cufemlab_client import Client

client = Client(api_key=os.environ["CUFEMLAB_API_KEY"])
project = client.create_project("3-D field validation")

# 3-D geometry (.step / .stp / .iges / .stl). CPU solve, free-trial eligible.
geom = client.upload_file(project.id, "magnet_assembly.step")

job = client.analyze(
    project_id=project.id,
    analysis_type="cufem3d_field_validation",
    input_params={"mesh_target": "medium"},
    input_file_ids=[geom.id],
)
job.wait(poll_interval=10)
result = job.result()

print(result.verdict, result.value)   # relative-error field verdict
print(result.metrics)                 # geometry / mesh / |B| / flux; VTU artifacts attached

import os
from cufemlab_client import Client

client = Client(api_key=os.environ["CUFEMLAB_API_KEY"])
project = client.create_project("GPU 3-D field analysis")

# Parametric - no upload. Runs on a compatible GPU worker.
# allow_cpu_fallback=False (the default) is FAIL-CLOSED: with no GPU the job
# fails instead of silently running on CPU.
job = client.analyze(
    project_id=project.id,
    analysis_type="cufem3d_gpu_field_analysis",
    input_params={
        "mesh_n": 24,                    # 12 - 32
        "box_L": 3.0,                    # 2.0 - 4.0
        "allow_cpu_fallback": False,
        "run_reference_check": True,     # also run the CPU parity check
    },
)
job.wait(poll_interval=10)
result = job.result()

# Runtime metadata reports the ACTUAL execution backend - never assume.
meta = result.value["runtime_metadata"]
print(meta["actual_backend"])            # "gpu"
print(meta["fallback_used"])            # False
print(meta["device_name"])              # e.g. "NVIDIA GeForce RTX 5090"
print(meta["analytic_relative_error"])  # vs the analytic sphere

import os
from cufemlab_client import Client

client = Client(api_key=os.environ["CUFEMLAB_API_KEY"])
project = client.create_project("Steel and magnet grades")

job = client.analyze(
    project_id=project.id,
    analysis_type="material_comparison",
    input_params={"materials": ["M250-35A", "M400-50A", "N42"]},
)
job.wait(poll_interval=10)
result = job.result()
print(result.verdict, result.summary)   # side-by-side grades from the catalog

import os
from cufemlab_client import Client

client = Client(api_key=os.environ["CUFEMLAB_API_KEY"])

source_job_id = "..."            # a COMPLETED job whose result you want to certify
src = client.get_job(source_job_id)

job = client.analyze(
    project_id=src.project_id,
    analysis_type="signed_report_generation",
    input_params={"source_job_id": source_job_id},
)
job.wait(poll_interval=5)
path = job.download_report("report.pdf")   # HMAC-signed PDF, SHA-256 provenance
print("Saved:", path)

import os
from cufemlab_client import Client

client = Client(api_key=os.environ["CUFEMLAB_API_KEY"])   # base url defaults to https://app.cufemlab.secrotec.nl
project = client.create_project("Quick motor check")

job = client.analyze(
    project_id=project.id,
    analysis_type="demo_motor_quick_check",
    input_params={"notes": "first smoke check"},
)
job.wait(poll_interval=10)
result = job.result()
print(result.verdict, result.value)