From 6226766917ce80988d92c6931875ed23884451ed Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Sat, 28 Dec 2024 18:04:34 -0700 Subject: [PATCH] [CLib_experimental] Add new interface --- interfaces/clib_experimental/.gitignore | 1 + interfaces/clib_experimental/README.md | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 interfaces/clib_experimental/.gitignore create mode 100644 interfaces/clib_experimental/README.md diff --git a/interfaces/clib_experimental/.gitignore b/interfaces/clib_experimental/.gitignore new file mode 100644 index 0000000000..424c745c12 --- /dev/null +++ b/interfaces/clib_experimental/.gitignore @@ -0,0 +1 @@ +*.h diff --git a/interfaces/clib_experimental/README.md b/interfaces/clib_experimental/README.md new file mode 100644 index 0000000000..57afe42f38 --- /dev/null +++ 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.