[CLib_experimental] Add new interface

Cantera · Dec 29, 2024 · 6226766 · 6226766
1 parent 40afa1d
commit 6226766
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/interfaces/clib_experimental/.gitignore b/interfaces/clib_experimental/.gitignore
@@ -0,0 +1 @@
+*.h
diff --git a/interfaces/clib_experimental/README.md b/interfaces/clib_experimental/README.md
@@ -0,0 +1,21 @@
+# Cantera – Experimental CLib Interface
+
+This directory and its children contain an experimental re-implementation of Cantera's
+CLib interface.
+
+## Code Generation
+
+After [building the main Cantera library](https://cantera.org/stable/develop/index.html)
+the doxygen XML files should be generated via `scons doxygen`. Then, switch to this
+directory and run:
+
+```
+python ../sourcegen/run.py clib .
+```
+
+At the moment, only header files are generated.
+
+## Status
+
+The experimental CLib Interface is in preview and still missing many features
+needed for parity with the traditional CLib interface.