parkol 0.1.0__tar.gz

parkol-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sarat Moka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

parkol-0.1.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: parkol
+Version: 0.1.0
+Summary: Exact uniform sampling of proper graph colourings via soft colouring and partial rejection sampling
+Author-email: Sarat Moka <s.moka@unsw.edu.au>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/smoka-unsw/parkol
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: networkx
+Dynamic: license-file
+
+# PaRKol
+
+**Pa**rtial **R**ejection sampling for **K**-c**ol**ouring.
+
+Exact uniform sampling of proper *k*-colourings of a graph, via the soft colouring framework.
+
+## Installation
+
+```bash
+pip install parkol
+```
+
+## Quick Start
+
+```python
+import networkx as nx
+from parkol import sample_coloring, verify_coloring
+
+G = nx.petersen_graph()
+colors = sample_coloring(G, k=5)
+print(verify_coloring(G, colors))  # True
+```
+
+## Methods
+
+| Method | Description | Condition |
+|--------|-------------|-----------|
+| `'hybrid'` | PRS + CFTP on components (default) | k > Δ |
+| `'prs'` | Pure γ-PRS | k > Δ |
+| `'cftp_huber'` | Huber (2004) bounding-chain CFTP | k > Δ |
+| `'cftp_bc20'` | Bhandari & Chakraborty (2020) CFTP | k > 3Δ |
+| `'nrs'` | Naive rejection sampling | k > Δ |
+
+```python
+colors = sample_coloring(G, k=5, method='hybrid', seed=42)
+```
+
+## Documentation
+
+Full documentation: [https://parkol.readthedocs.io](https://parkol.readthedocs.io)
+
+## Reference
+
+S. Moka et al. (2026). *Near-Linear Time Perfect Sampling of Graph Colourings via Soft Colouring.* Preprint.
+
+## License
+
+MIT

parkol-0.1.0/README.md

@@ -0,0 +1,48 @@
+# PaRKol
+
+**Pa**rtial **R**ejection sampling for **K**-c**ol**ouring.
+
+Exact uniform sampling of proper *k*-colourings of a graph, via the soft colouring framework.
+
+## Installation
+
+```bash
+pip install parkol
+```
+
+## Quick Start
+
+```python
+import networkx as nx
+from parkol import sample_coloring, verify_coloring
+
+G = nx.petersen_graph()
+colors = sample_coloring(G, k=5)
+print(verify_coloring(G, colors))  # True
+```
+
+## Methods
+
+| Method | Description | Condition |
+|--------|-------------|-----------|
+| `'hybrid'` | PRS + CFTP on components (default) | k > Δ |
+| `'prs'` | Pure γ-PRS | k > Δ |
+| `'cftp_huber'` | Huber (2004) bounding-chain CFTP | k > Δ |
+| `'cftp_bc20'` | Bhandari & Chakraborty (2020) CFTP | k > 3Δ |
+| `'nrs'` | Naive rejection sampling | k > Δ |
+
+```python
+colors = sample_coloring(G, k=5, method='hybrid', seed=42)
+```
+
+## Documentation
+
+Full documentation: [https://parkol.readthedocs.io](https://parkol.readthedocs.io)
+
+## Reference
+
+S. Moka et al. (2026). *Near-Linear Time Perfect Sampling of Graph Colourings via Soft Colouring.* Preprint.
+
+## License
+
+MIT

parkol-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "parkol"
+version = "0.1.0"
+description = "Exact uniform sampling of proper graph colourings via soft colouring and partial rejection sampling"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+authors = [
+    {name = "Sarat Moka", email = "s.moka@unsw.edu.au"},
+]
+dependencies = [
+    "numpy",
+    "scipy",
+    "networkx",
+]
+
+[project.urls]
+Homepage = "https://github.com/smoka-unsw/parkol"
+
+[tool.setuptools.packages.find]
+where = ["src"]

parkol-0.1.0/setup.cfg

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

parkol-0.1.0/src/parkol/__init__.py

@@ -0,0 +1,11 @@
+"""
+parkol -- Exact uniform sampling of proper graph colourings.
+
+Uses gamma-soft colouring and partial rejection sampling (PRS).
+"""
+
+from .sample import sample_coloring
+from .utils import verify_coloring
+
+__version__ = "0.1.0"
+__all__ = ["sample_coloring", "verify_coloring"]