Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add overview of Python/Cython/C++ interactions #183

Open
ischoegl opened this issue Aug 9, 2023 · 0 comments
Open

Add overview of Python/Cython/C++ interactions #183

ischoegl opened this issue Aug 9, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation feature-request New feature request Python

Comments

@ischoegl
Copy link
Member

ischoegl commented Aug 9, 2023

Abstract

Cantera is implemented in C++, while Cython serves as the interface to the Python API, which presumably is the main interface Cantera users are using.

While the topic is advanced, it would be useful to provide an overview of how the C++ core interacts with the Python front end, as well as how C++ objects receive data from YAML input files.

A similar issue exists for the clib C-interface used by new MATLAB and C# interfaces.

Motivation

Describe the need for the proposed feature:

  • What problem is it trying to solve? ... provide a quick overview to new dev's
  • Who is affected by the change? ... users interested in the inner workings of Cantera
  • Why is this a good solution? ... it hopefully improves the learning curves and increases community participation

Possible Solutions

Add a *.md file to the doxygen documentation.

@ischoegl ischoegl added documentation Improvements or additions to documentation feature-request New feature request Python labels Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature-request New feature request Python
Projects
None yet
Development

No branches or pull requests

1 participant