kmclab 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- kmclab/__init__.py +5 -0
- kmclab/hex.py +1072 -0
- kmclab/square.py +1078 -0
- kmclab-0.1.0.dist-info/METADATA +49 -0
- kmclab-0.1.0.dist-info/RECORD +7 -0
- kmclab-0.1.0.dist-info/WHEEL +5 -0
- kmclab-0.1.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: kmclab
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Hex and square lattice KMC classes.
|
|
5
|
+
Author: Shirin Asadi
|
|
6
|
+
License: MIT
|
|
7
|
+
Requires-Python: >=3.9
|
|
8
|
+
Description-Content-Type: text/markdown
|
|
9
|
+
|
|
10
|
+
# kmclab
|
|
11
|
+
|
|
12
|
+
A lightweight Python package for lattice-based kinetic Monte Carlo (KMC) utilities.
|
|
13
|
+
Currently includes simple hexagonal and square lattice KMC classes.
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
Clone the repository and install in editable mode:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
git clone https://github.com/shirinasadix/kmclab.git
|
|
21
|
+
cd kmclab
|
|
22
|
+
pip install -e .
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
```from kmclab import hex_kmc, square_kmc
|
|
28
|
+
|
|
29
|
+
hex_model = hex_kmc(...)
|
|
30
|
+
sq_model = square_kmc(...)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Package Structure
|
|
34
|
+
|
|
35
|
+
kmclab/
|
|
36
|
+
├── src/
|
|
37
|
+
│ └── kmclab/
|
|
38
|
+
│ ├── hex.py
|
|
39
|
+
│ ├── square.py
|
|
40
|
+
│ └── __init__.py
|
|
41
|
+
├── tests/
|
|
42
|
+
├── pyproject.toml
|
|
43
|
+
└── README.md
|
|
44
|
+
|
|
45
|
+
## License
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
XXX
|
|
49
|
+
```
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
kmclab/__init__.py,sha256=FFAJ4ujC8thjoNpf-wDJClxFpeSEtFiSe3wUeuP34JM,114
|
|
2
|
+
kmclab/hex.py,sha256=fMd2-GksOGcU9CbIklCTWOyYN6BMtchprk9zhpAb5r4,52406
|
|
3
|
+
kmclab/square.py,sha256=fqESHcMvMezpCrllQHnsMgOGTeOTQmW3P-Da5NqMqHs,52182
|
|
4
|
+
kmclab-0.1.0.dist-info/METADATA,sha256=4IO-l03XyLIBOYGLmKRS6ujUAyQsGYu1DA0BQwQpPck,876
|
|
5
|
+
kmclab-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
|
|
6
|
+
kmclab-0.1.0.dist-info/top_level.txt,sha256=y0neMRTLriRK2Sv_F3m9WUcs2JHEEVpCOC71fkrBrAY,7
|
|
7
|
+
kmclab-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
kmclab
|