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.

Reference

Complete reference documentation for OEDI-SI components, APIs, and data structures.

Available references

  1. Component catalog — all components available in the UI, with descriptions, configuration options, and links to source code.

  2. Data types — the oedisi.types Pydantic models that components use to exchange voltages, powers, topology, and other measurements.

  3. Python API — public classes and functions in the oedisi package (auto-generated from docstrings).

  4. Command-line interface — every oedisi command and option (auto-generated from the CLI).

  5. Glossary — definitions of key terms and concepts.

  6. Troubleshooting — common issues and solutions.

  7. Contributing — how to contribute to OEDI-SI.

  8. Citation — how to cite OEDI-SI in publications.