high_level_api

Public high-level API helpers for kMCpy.

kmcpy.api.run(config, label=None)[source]

Run a KMC simulation from a Configuration in one call.

Parameters:
  • config (Configuration) – Simulation configuration.

  • label (str | None) – Optional output label. If None, config.name is used.

Return type:

Tracker

Returns:

Tracker with simulation results.