Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Intermediate — build a component

This track is for developers who want to add a new algorithm or simulator to OEDI-SI. By the end you will have a working component that appears in the UI’s palette and runs in a simulation alongside the built-in ones.

What you’ll learn

  1. Build a component — the required files, the component_definition.json interface contract, the FastAPI server.py, and the HELICS subscribe/publish loop.

  2. Register it in the UI — add your component to the frontend registry so it shows up in the designer palette.

  3. Run your simulation — wire your component into a template, run it, and inspect the output.

Prerequisites