kmclab 0.1.0__tar.gz

kmclab-0.1.0/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: kmclab
+Version: 0.1.0
+Summary: Hex and square lattice KMC classes.
+Author: Shirin Asadi
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# kmclab
+
+A lightweight Python package for lattice-based kinetic Monte Carlo (KMC) utilities.  
+Currently includes simple hexagonal and square lattice KMC classes.
+
+## Installation
+
+Clone the repository and install in editable mode:
+
+```bash
+git clone https://github.com/shirinasadix/kmclab.git
+cd kmclab
+pip install -e .
+```
+
+## Usage
+
+```from kmclab import hex_kmc, square_kmc
+
+hex_model = hex_kmc(...)
+sq_model = square_kmc(...)
+```
+
+## Package Structure 
+
+kmclab/
+├── src/
+│   └── kmclab/
+│       ├── hex.py
+│       ├── square.py
+│       └── __init__.py
+├── tests/
+├── pyproject.toml
+└── README.md
+
+## License
+
+```
+XXX
+```

kmclab-0.1.0/README.md

@@ -0,0 +1,40 @@
+# kmclab
+
+A lightweight Python package for lattice-based kinetic Monte Carlo (KMC) utilities.  
+Currently includes simple hexagonal and square lattice KMC classes.
+
+## Installation
+
+Clone the repository and install in editable mode:
+
+```bash
+git clone https://github.com/shirinasadix/kmclab.git
+cd kmclab
+pip install -e .
+```
+
+## Usage
+
+```from kmclab import hex_kmc, square_kmc
+
+hex_model = hex_kmc(...)
+sq_model = square_kmc(...)
+```
+
+## Package Structure 
+
+kmclab/
+├── src/
+│   └── kmclab/
+│       ├── hex.py
+│       ├── square.py
+│       └── __init__.py
+├── tests/
+├── pyproject.toml
+└── README.md
+
+## License
+
+```
+XXX
+```

kmclab-0.1.0/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "kmclab"
+version = "0.1.0"
+description = "Hex and square lattice KMC classes."
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [{name = "Shirin Asadi"}]
+license = {text = "MIT"}
+dependencies = []
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

kmclab-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

kmclab-0.1.0/src/kmclab/__init__.py

@@ -0,0 +1,5 @@
+from .hex import hex_kmc
+from .square import square_kmc
+
+__all__ = ["hex_kmc", "square_kmc"]
+__version__ = "0.1.0"