Python API

The Python API mirrors the command-line host. It discovers installed components, loads a component by group and name, and dispatches arguments to that component.

from heliokit import Heliokit

kit = Heliokit()

for component in kit.list_components():
    print(component.metadata.kind, component.metadata.operation, component.metadata.name)

summary = kit.read_data(
    "vti",
    input=r"D:\data\volume.vti",
)

plot = kit.visualize_2d(
    "histogram",
    input=r"D:\data\sample.plt",
    array="BR",
    save=r"D:\plots\histogram.png",
    show=False,
)

Component metadata

Components expose metadata through heliokit-base. A host can inspect kind, operation, name, and command argument specifications before executing the component.

component = kit.get_component("data", "vti")
print(component.metadata)
output = component.run(input=r"D:\data\volume.vti")