Metadata-Version: 2.4
Name: cgkmc
Version: 0.0.2
Summary: Crystal Growth Kinetic Monte Carlo
Project-URL: Homepage, https://github.com/jwjeffr/cgkmc
License-Expression: MIT
License-File: LICENSE
Keywords: crystal,graph,growth,kmc,morphology,nanocrystal,surface
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Requires-Dist: numpy~=2.0.2
Requires-Dist: scipy~=1.13.1
Provides-Extra: dev
Requires-Dist: hatchling~=1.27.0; extra == 'dev'
Requires-Dist: mypy~=1.13.0; extra == 'dev'
Requires-Dist: pdoc~=15.0.1; extra == 'dev'
Requires-Dist: pytest~=8.0.2; extra == 'dev'
Requires-Dist: ruff~=0.9.4; extra == 'dev'
Description-Content-Type: text/markdown

# cgkmc

[![Custom shields.io](https://img.shields.io/badge/docs-brightgreen?logo=github&logoColor=green&label=gh-pages)](https://jwjeffr.github.io/cgkmc/)

[![PyPI version shields.io](https://img.shields.io/pypi/v/cgkmc.svg)](https://pypi.python.org/pypi/cgkmc/)
[![PyPI pyversions shields.io](https://img.shields.io/pypi/pyversions/cgkmc.svg)](https://pypi.python.org/pypi/cgkmc/)

## 💎 What is cgkmc?

`cgkmc` is a package for performing crystal growth simulations using the 
[Kinetic Monte Carlo](https://en.wikipedia.org/wiki/Kinetic_Monte_Carlo) method. `cgkmc`'s namesake is shorthand for
Crystal Growth Kinetic Monte Carlo.

## 📥 Installation

```bash
pip install cgkmc
```

📃 License

`cgkmc` is released under the MIT License.