cppkh-interface 0.1.0__tar.gz

cppkh_interface-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: cppkh-interface
+Version: 0.1.0
+Summary: Python interface for cppkh Khovanov homology computation with runtime C++ compilation.
+License-Expression: MIT
+Author: GGN_2015
+Author-email: neko@jlulug.org
+Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: cpp-simple-interface (>=0.1.2)
+Requires-Dist: pd-code-de-r1
+Requires-Dist: pd-code-delete-nugatory
+Requires-Dist: pd-code-sanity (>=0.0.1)
+Project-URL: Documentation, https://github.com/GGN-2015/cppkh/blob/main/docs/PYTHON_PACKAGE.md
+Project-URL: Homepage, https://github.com/GGN-2015/cppkh
+Project-URL: Repository, https://github.com/GGN-2015/cppkh
+Description-Content-Type: text/markdown
+
+# cppkh-interface
+
+`cppkh-interface` is a Python package for computing integer Khovanov homology
+with the C++ `cppkh` implementation.
+
+The package is compatible with the main `javakh-interface` function:
+
+```python
+import cppkh_interface
+
+pd_code = [[1, 5, 2, 4], [3, 1, 4, 6], [5, 3, 6, 2]]
+print(cppkh_interface.solve_khovanov(pd_code, de_r1=True, de_k8=True))
+```
+
+Unlike wrappers that ship a prebuilt DLL or shared object, this package ships
+the `cppkh` C++ source file and compiles a local executable on first use through
+`cpp-simple-interface`. The compiled executable is cached for later calls.
+
+## Install
+
+```sh
+pip install cppkh-interface
+```
+
+A `g++` compatible compiler must be available at runtime. To select a compiler,
+set `CXX` before importing or calling the package:
+
+```sh
+CXX=clang++ python your_script.py
+```
+
+Windows PowerShell:
+
+```powershell
+$env:CXX = "C:\path\to\g++.exe"
+python your_script.py
+```
+
+## Build And Publish
+
+From this directory:
+
+```sh
+poetry build
+poetry publish
+```
+
+For local testing:
+
+```sh
+poetry run python -m cppkh_interface "[[1,5,2,4], [3,1,4,6], [5,3,6,2]]"
+```
+

cppkh_interface-0.1.0/README.md

@@ -0,0 +1,52 @@
+# cppkh-interface
+
+`cppkh-interface` is a Python package for computing integer Khovanov homology
+with the C++ `cppkh` implementation.
+
+The package is compatible with the main `javakh-interface` function:
+
+```python
+import cppkh_interface
+
+pd_code = [[1, 5, 2, 4], [3, 1, 4, 6], [5, 3, 6, 2]]
+print(cppkh_interface.solve_khovanov(pd_code, de_r1=True, de_k8=True))
+```
+
+Unlike wrappers that ship a prebuilt DLL or shared object, this package ships
+the `cppkh` C++ source file and compiles a local executable on first use through
+`cpp-simple-interface`. The compiled executable is cached for later calls.
+
+## Install
+
+```sh
+pip install cppkh-interface
+```
+
+A `g++` compatible compiler must be available at runtime. To select a compiler,
+set `CXX` before importing or calling the package:
+
+```sh
+CXX=clang++ python your_script.py
+```
+
+Windows PowerShell:
+
+```powershell
+$env:CXX = "C:\path\to\g++.exe"
+python your_script.py
+```
+
+## Build And Publish
+
+From this directory:
+
+```sh
+poetry build
+poetry publish
+```
+
+For local testing:
+
+```sh
+poetry run python -m cppkh_interface "[[1,5,2,4], [3,1,4,6], [5,3,6,2]]"
+```

cppkh_interface-0.1.0/cppkh_interface/__init__.py

@@ -0,0 +1,19 @@
+from .main import (
+    CppkhInterfaceError,
+    compile_cppkh,
+    compute_pd,
+    get_cppkh_executable,
+    normalize_pd_code,
+    simplify_pd,
+    solve_khovanov,
+)
+
+__all__ = [
+    "CppkhInterfaceError",
+    "compile_cppkh",
+    "compute_pd",
+    "get_cppkh_executable",
+    "normalize_pd_code",
+    "simplify_pd",
+    "solve_khovanov",
+]

cppkh_interface-0.1.0/cppkh_interface/__main__.py

@@ -0,0 +1,4 @@
+from .main import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())