Reference Overview

Use the reference section when you need exact API names, class signatures, or module-level documentation. For task-oriented workflows, start with the workflow tutorial or advanced pages.

API Reference

The API reference is generated from the Python source and docstrings:

• API reference

Configuration Fields

To inspect valid configuration fields from your installed version:

uv run python -c "from kmcpy.simulator.config import Configuration; Configuration.help_fields()"

This is often the fastest way to check whether a field belongs to the physical system configuration or runtime controls.