Welcome to kmos’s documentation!¶
Things you can do with kmos.
kmos is a vigorous attempt to make (lattice) kMC modelling more accessible.
kmos is designed for and by kMC model developers. As of this writing there is no standardized way to develop kMC models, thus there is no standardized way to use kmos. kmos can be an Editor, an API, a viewer. However all in all kmos wants to save time filled with repetitive labor and enlarge your stride.
Not sure how to begin? Start with the API tutorial.
- Tutorials
- Topic Guides
- The Concept of Kinetic Monte Carlo
- Modelling Workflows
- The kmos data model
- How the kmos kMC algorithm works
- The otf Backend
- The Process Syntax
- The Site/Coordinate Syntax
- Developer’s guide
- Introduction and disclaimer
- Some nomenclature.
- The three backends
- The structure of the FORTRAN code.
- Key data-structures
- One kmc step in kmos
- The code generation routines
- Reference
- Command Line Interface (CLI)
- Data Types
- Editor frontend
- Runtime frontend
- kmos kMC project DTD
- Backends
- local_smart
- kmos/base
- base/accum_rates
- base/add_proc
- base/allocate_system
- base/assertion_fail
- base/avail_sites
- base/can_do
- base/deallocate_system
- base/del_proc
- base/determine_procsite
- base/get_accum_rate
- base/get_avail_site
- base/get_integ_rate
- base/get_kmc_step
- base/get_kmc_time
- base/get_kmc_time_step
- base/get_kmc_volume
- base/get_nrofsites
- base/get_procstat
- base/get_rate
- base/get_species
- base/get_system_name
- base/get_walltime
- base/increment_procstat
- base/integ_rates
- base/interval_search_real
- base/kmc_step
- base/kmc_time
- base/kmc_time_step
- base/lattice
- base/nr_of_proc
- base/nr_of_sites
- base/procstat
- base/rates
- base/reload_system
- base/replace_species
- base/reset_site
- base/save_system
- base/set_kmc_time
- base/set_rate_const
- base/set_system_name
- base/start_time
- base/system_name
- base/update_accum_rate
- base/update_clocks
- base/update_integ_rate
- base/volume
- base/walltime
- kmos/lattice
- kmos/proclist
- kmos/base
- lat_int
- kmos/base
- base/accum_rates
- base/add_proc
- base/allocate_system
- base/assertion_fail
- base/avail_sites
- base/can_do
- base/deallocate_system
- base/del_proc
- base/determine_procsite
- base/get_accum_rate
- base/get_avail_site
- base/get_integ_rate
- base/get_kmc_step
- base/get_kmc_time
- base/get_kmc_time_step
- base/get_kmc_volume
- base/get_nrofsites
- base/get_procstat
- base/get_rate
- base/get_species
- base/get_system_name
- base/get_walltime
- base/increment_procstat
- base/integ_rates
- base/interval_search_real
- base/kmc_step
- base/kmc_time
- base/kmc_time_step
- base/lattice
- base/nr_of_proc
- base/nr_of_sites
- base/procstat
- base/rates
- base/reload_system
- base/replace_species
- base/reset_site
- base/save_system
- base/set_kmc_time
- base/set_rate_const
- base/set_system_name
- base/start_time
- base/system_name
- base/update_accum_rate
- base/update_clocks
- base/update_integ_rate
- base/volume
- base/walltime
- kmos/lattice
- proclist/do_kmc_step
- kmos/base
- otf
- kmos/base
- base/accum_rates
- base/accum_rates_proc
- base/add_proc
- base/allocate_system
- base/assertion_fail
- base/avail_sites
- base/can_do
- base/deallocate_system
- base/del_proc
- base/determine_procsite
- base/get_accum_rate
- base/get_avail_site
- base/get_integ_rate
- base/get_kmc_step
- base/get_kmc_time
- base/get_kmc_time_step
- base/get_kmc_volume
- base/get_nrofsites
- base/get_procstat
- base/get_rate
- base/get_species
- base/get_system_name
- base/get_walltime
- base/increment_procstat
- base/integ_rates
- base/interval_search_real
- base/kmc_step
- base/kmc_time
- base/kmc_time_step
- base/lattice
- base/nr_of_proc
- base/nr_of_sites
- base/procstat
- base/rates
- base/rates
- base/reaccumulate_rates_matrix
- base/reload_system
- base/replace_species
- base/reset_site
- base/save_system
- base/set_kmc_time
- base/set_rate_const
- base/set_system_name
- base/start_time
- base/system_name
- base/update_accum_rate
- base/update_clocks
- base/update_integ_rate
- base/update_rates_matrix
- base/volume
- base/walltime
- kmos/lattice
- proclist/do_kmc_step
- kmos/base
- local_smart
- Trouble Shooting
- Frequently Asked Questions
This document was generated Apr 30, 2018.