Sourcegen CLib edge cases

[ischoegl]

Changes proposed in this pull request

Address several edge cases encountered in CLib

• Extend auto-generation of CLib APIs to variables (not just functions)
• Use ReactionPathDiagram as an example (also, C++ API is updated to match Python API)
• Expose Cantera constants to CLib
• Implement CLib loggers

If applicable, fill in the issue number this pull request is fixing

Addresses Cantera/enhancements#220

Checklist

• The pull request includes a clear description of this code change
• Commit messages have short titles and reference relevant issues
• Build passes (scons build & scons test) and unit tests address code coverage
• Style & formatting of contributed code follows contributing guidelines
• The pull request is ready for review

[codecov]

Codecov Report

Attention: Patch coverage is 60.41667% with 19 lines in your changes missing coverage. Please review.

Project coverage is 74.39%. Comparing base (e6f3e9d) to head (fc7926b).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
src/kinetics/ReactionPath.cpp	59.45%	12 Missing and 3 partials ⚠️
interfaces/cython/cantera/reactionpath.pyx	63.63%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1846      +/-   ##
==========================================
- Coverage   74.41%   74.39%   -0.02%     
==========================================
  Files         386      386              
  Lines       53628    53651      +23     
  Branches     9063     9071       +8     
==========================================
+ Hits        39905    39913       +8     
- Misses      10652    10663      +11     
- Partials     3071     3075       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[speth]

Thanks, @ischoegl. This generally looks good to me. Just a few minor suggestions.

[speth]

The @param and @return notations here add nothing beyond what's either stated in the prose description above or explicitly given by the argument/return types. I would suggest removing them.

[ischoegl]

For the current CLib code generation, we only care about the @brief description, as well as @param and @return. From that perspective, the extended docstring is secondary. I updated both docstrings so they are less redundant. In the future, sourcegen may pick up more information; for the time being, I am trying to make sure that the most relevant docstrings are in place.

[speth]

Not a recommendation for this PR, but I'm getting the impression that ReactionPathBuilder should just be merged with ReactionPathDiagram. They seem to be intricately connected and I'm not sure there's any benefit of having the former as a separate class.

[ischoegl]

Agreed. For this PR, my main concern was to streamline the API; the ReactionPathDiagram code base definitely needs another look, perhaps with Cantera/enhancements#173? The logging is likewise no longer consistent with our current approaches.

[ischoegl]

@speth ... thanks for the review. The PR should be ready to merge.

[ischoegl]

@speth ... this should be done/ready.