Cantera/Adding Python Class Via C++: Difference between revisions
From charlesreid1
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
The following instructions describe how to implement a new C++ class in Cantera 2.1 and make it accessible via Python. | The following instructions describe how to implement a new C++ class in Cantera 2.1 and make it accessible via Python. | ||
Hopefully this will save you the headaches and streams of expletives that navigating changes between 2.0 and 2.1 caused me. | Hopefully this will save you the headaches and streams of expletives that navigating changes between 2.0 and 2.1 caused me. | ||
(Note to Cantera developers: if you break backwards compatibility and change the way the API works, you need to increment the MAJOR version number, not the MINOR version number.) | |||
=Overview= | =Overview= | ||
Revision as of 18:37, 12 August 2014
The following instructions describe how to implement a new C++ class in Cantera 2.1 and make it accessible via Python.
Hopefully this will save you the headaches and streams of expletives that navigating changes between 2.0 and 2.1 caused me.
(Note to Cantera developers: if you break backwards compatibility and change the way the API works, you need to increment the MAJOR version number, not the MINOR version number.)
Overview
To add a new C++ class in Cantera, you will need to follow a couple of steps:
1. Add the C++ code for the class
2. Wrap the new C++ code with the C API
3. Create a Python object that calls the C API code
4. Create a Cython object
This fourth step is new to Cantera 2.1.