Skip to content

kMCpy 0.3.0 documentation

kMCpy 0.3.0 documentation

Start Here

Installation
Quickstart

Theory

Theory

Tutorial

Workflow Overview

Advanced

Advanced Overview

Reference

Reference Overview
- API Reference Documentation
  - init
  - main
  - run_kmc
  - event_base
  - generators
  - hop
  - comparator
  - active_site_order
  - basis
  - cluster
  - lattice_structure
  - local_environment_enumerator
  - local_lattice_structure
  - local_site_order
  - neighbors
  - sites
  - species
  - data
  - cif
  - io_registry
  - models_fitting_registry
  - fitter
  - models_base
  - composite_lce_model
  - local_barrier_model
  - local_cluster_expansion
  - parameters
  - site_energy
  - config
  - kmc
  - property
  - results
  - state
  - tracker
  - high_level_api
  - units
  - neb

Project

About
How to cite

io_registry¶

Shared registry definitions for I/O modules.

models_fitting_registry

Copyright © 2022-2026, Canepa Research Lab and DENG Group

Made with Sphinx and @pradyunsg's Furo