Welcome to kmcos’s documentation!¶
Things you can do with kmcos.
kmcos is a vigorous attempt to make (lattice) kMC modelling more accessible.
kmcos 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 kmcos. kmcos can be an Editor, an API, a viewer. However all in all kmcos wants to save time filled with repetitive labor and enlarge your stride.
Not sure how to begin? Start with the API tutorial.
- Installation
- Making a Python Virtual Environment for kmcos within Ubuntu
- Installing kmcos on Ubuntu Linux
- Installing kmcos on Fedora Linux (typically inside a virtual environment)
- Installation on openSUSE 12.1 Linux (Deprecated Instructions)
- Installation on openSUSE 13.1 Linux (Deprecated Instructions)
- Installation on Mac OS X 10.10 or above (Deprecated Instructions)
- Installation on windows
- Installing JANAF Thermochemical Tables
- Tutorials
- Topic Guides
- The Concept of Kinetic Monte Carlo
- Modelling Workflows
- The kmcos data model
- How the kmcos kMC algorithm works
- Temporal acceleration
- The otf Backend
- The Process Syntax
- The Site/Coordinate Syntax
- Developer’s guide
- Introduction and disclaimer
- How to edit, install, and test your changes locally
- Some nomenclature
- The three backends
- The structure of the FORTRAN code.
- Key data-structures
- One kmc step in kmcos
- The code generation routines
- Reference
- Model running commands
- Connected Variables
- Data Types
- Editor frontend
- Runtime frontend
- kmcos kMC project DTD
- Backends
- local_smart
- kmcos/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_step
- 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
- kmcos/lattice
- kmcos/proclist
- kmcos/kind_values
- kmcos/base
- lat_int
- kmcos/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
- kmcos/lattice
- kmcos/proclist
- proclist/do_kmc_step
- kmcos/kind_values
- kmcos/base
- otf
- kmcos/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
- kmcos/lattice
- kmcos/proclist
- proclist/do_kmc_step
- kmcos/kind_values
- kmcos/base
- local_smart
- Command Line Interface (CLI)
- Trouble Shooting
- Frequently Asked Questions
This document was generated Apr 12, 2023.