[WIP] API changes for Julia bindings #1016
Conversation
|
Any opinion on this @simonpintarelli, @mtaillefumier ? |
|
No major objections especially if the header file generated automatically. |
|
The docstrings are now duplicated in the header and in |
Good catch @simonpintarelli ! However, I would still use sirius_api.cpp as a source of truth for the documentation and a bare header file only for Julia bindings. @abussy will it be possible to cleanup .h file from the doc. comments? |
|
My script to generate Julia bindings makes use of the docstrings. I am also not sure I could get the data from |
This PR brings some changes to the API, in order to facilitate the creation of Julia bindings for SIRIUS in a future SIRIUS.jl package. Apart from the additions of new functions to sirius_api.cpp (necessary for the DFTK integration), the main addition consists of a header file for the API: sirius_c_headers.h. It turns out that having a header file drastically simplifies the process of creating Julia bindings for a C/C++ library. As things stand, this header file is generated by a script (generate_c_headers.py), in the same spirit as the Fortran API. As a result, it is not used for compilation, but only as source material for the automatic generation of Julia bindings.
This PR brings some changes to the API, in order to facilitate the creation of Julia bindings for SIRIUS in a future
SIRIUS.jlpackage.Apart from the additions of new functions to
sirius_api.cpp(necessary for theDFTKintegration), the main addition consists of a header file for the API:sirius_c_headers.h. It turns out that having a header file drastically simplifies the process of creating Julia bindings for a C/C++ library.As things stand, this header file is generated by a script (
generate_c_headers.py), in the same spirit as the Fortran API. As a result, it is not used for compilation, but only as source material for the automatic generation of Julia bindings.The above point is why this PR is marked as WIP. I believe we might want to have a discussion as to whether we follow this direction, or if we decide to have a proper header file that we also use for compilation.