TREX-CoE / qmckl

Quantum Monte Carlo Kernel Library

Home Page:http://trex-coe.github.io/qmckl/index.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Autogenerate c and fortran interface

v1j4y opened this issue · comments

commented

The c and fortran inteface of qmckl can be set up to be autogenerated from the documentation of the functions.

There are multiple advantages of this strategy which are as follows:

  • Consistent interface generation
  • Consistent conventions of function names
  • Consistent conventions for arguments
  • Documentation is by construction up to date with the code
  • Users and developers are not required to write the interface thus reducing hand written lines of code

Some important points that need to be stressed while adopting this strategy are as follows:

  • New users and developers need to be introduced to the documentation procedure
  • A standard has to be clearly documented and defined
commented

Merged into master.