Skip to main content
https://img.shields.io/badge/license-GPLv3-brightgreen.svg?style=flat-square):targetCOPYING Documentation Status

kmcos: Kinetic Monte Carlo of Systems

kmcos is designed for lattice based Kinetic Monte Carlo simulations to understand chemical kinetics and mechanisms. It has been used to produce more than 10 scientific publications. Links to tutorials and other documentation are below.

DOCUMENTATION

Please refer to

HELP, BUGS, ISSUES, TROUBLE

This code is research code for scientists by scientists. If you believe you have hit a bug, have a feature request get in touch with us either via the mailing list, or open an issue .

CONTRIBUTORS

Current Project Leaders:

  • Karsten Reuter

  • Aditya (Ashi) Savara

Creator:

  • Max J. Hoffmann

Developers:

  • Sebastian Matera

  • Juan M. Lorenzi

  • Mie Andersen

  • Michal Bajdich

  • Andreas Garhammer

Other: * Martin Deimel * Thomas Danielson * Jonathan Sutton * Joseba Alberdi * Steve Erwin & NB * Meelod Waheed

THANKS

This project draws on several other great Python modules, which are in turn each free software and we would like to thank each of these projects for making their code freely avalaible, namely:

FILES

├── COPYING # Copy of GPLv3
├── INSTALL.rst # installation instructions
├── README.rst # This document
├── TODO.rst # Ideas for improvement and new features
├── requirements.txt # Dependencies which can be installed via pip
├── setup.py # setuptools using setup script
├── index.html # landing website
├── kmcos/ # the core kmcos python modules
│   ├── cli.py # the command line interface
│   ├── config.py # configuration of some project wide paths
│   ├── fortran_src/ # static Fortran 90 source files
│   │   ├── assert.ppc # assertion macro
│   │   ├── base.f90 # the default kMC solver
│   │   ├── base_lat_int.f90 # slightly modified kMC solver for lat_int backend
│   │   ├── kind_values.f90 # definition of project wide kind values
│   │   └── main.f90 # source template for standalone Fortran 90 clients
│   ├── gui/ # kmcos.gui module
│   │   ├── forms.py # view definitions (MVC) of editor GUI
│   │   └── __init__.py # controller definitions (MVC) of editor GUI
│   ├── __init__.py # root import module
│   ├── io.py # conversion between format: contains main Code Generator
│   ├── kmc_editor.glade # Glade XML definiton for form interfaces
│   ├── kmc_project_v0.1.dtd # Document Type Definition file of kMC project v0.1
│   ├── kmc_project_v0.2.dtd # Document Type Definition file of kMC project v0.2
│   ├── run.py # High-level API for compiled models
│   ├── species.py # Convenient interface for some reaction intermediates
│   ├── types.py # The basic classes for building kMC models
│   ├── units.py # Definition of conversion factor (CODATA 2010)
│   ├── utils/ # Utility function that didn’t fit elsewhere
│   │   ├── __init__.py
│   │   ├── ordered_dict.py
│   │   ├── progressbar.py
│   │   └── terminal.py
│   └── view.py # The runtime GUI for compiled models
├── doc/ # user guide, documentation, and reference
│   └── source/ # documentation source file for compilation with Sphinx
├── examples/ # demoing non-standard features and useful idioms
│   ├── AB_model.py # small demo file
│   ├── benchmark_compilers_and_backends.sh # demo file
│   ├── crowded.xml # demo file
│   ├── dreiD.xml # demo file for 3d model
│   ├── dummy.xml # mininal model
│   ├── model_Pt111_surface.py # demo file for non-rectangular lattice
│   ├── multidentate.py # basic example for multidentate adsorption
│   ├── render_bigcell.py # demo containing many sites
│   ├── render_co_oxidation_ruo2.py # demoing th CO Oxidation at RuO2(110) model
│   ├── render_diffusion_model.py # idioms for describing lateral interaction
│   ├── render_einsD.py # simple 1-dimensional model
│   ├── render_multispecies.py # render many species
│   ├── render_pairwise_interaction.py # idioms for describing lateral interaction
│   ├── render_Pt_111.py # another non-rectangular lattice
│   ├── render_sand_model.py # a neat diffusion model for non-trivial boundary conditions
│   ├── run_in_multi_process.py # an example for parallelization over processes
│   ├── run.py # a high-level run script using the ModelRunner metaclass
│   ├── ruptured_Pd.xml # a fcc(100) like surface with some sites missing
│   └── small.xml # demo file
├── tests/ # Unit tests and test data
├── tools # Entry points for command line interface
│   ├── kmcos
│   ├── kmcos.bat
│   ├── kmcos-build-standalone
│   └── kmcos-install-dependencies-ubuntu

Metadata

Release files for kmcos 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kmcos 1.1.0
File Size Uploaded Provenance Actions
kmcos-1.1.0.tar.gz 290.4 kB Without provenance Details for kmcos-1.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for kmcos 1.1.0
File Interpreter ABI Platform Actions
kmcos-1.1.0-py3-none-any.whl Python 3 none any Details for kmcos-1.1.0-py3-none-any.whl

Total release size: 608.8 kB

Release files / kmcos-1.1.0.tar.gz

Download URL kmcos-1.1.0.tar.gz
Size 290.4 kB
Tags Source
SHA-256 checksum
How to use checksums
317d1c10ab80d71c7fb31a944187690298ef723888850e72e8a8207e378a6da6
BLAKE2b-256 checksum
How to use checksums
0dbe79970fa8b4ed3c054c4fe94a4f3fee8f9434dec13a35695c8092db5062f3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.1

Release files / kmcos-1.1.0-py3-none-any.whl

Download URL kmcos-1.1.0-py3-none-any.whl
Size 318.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d3dd66da4725f7788dc72ef2282c610fc9b9b8afbb2e26f8cf00b17abad520bd
BLAKE2b-256 checksum
How to use checksums
9c9be3fdf4ce1968f936f4ada7a30b4f4cbcd70aff7bf0332c9353a1bde3a778
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.1

Security for kmcos 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page