None of the thorns in WVUThorns_Diagnostics have documentation

Create issue
Issue #2469 new
Roland Haas created an issue

All thorns in the WVUThorns_Diagnostics arrangement are lacking a file documentation.tex and thus

Having documentation is a requirement for inclusion in the ET (http://einsteintoolkit.org/contribute.html)

* Components should be of sufficient quality to be used for peer-reviewed and published science. This includes a basic standard of software engineering, documentation of the software including algorithms and methods, tutorials and examples, and self-tests to demonstrate that the software works correctly.

The source code uses an misleading extension for C source files namely it used .C (uppercase letter “c”) which in GNU make (and Cactus) is used for C++ files so is compiled with g++ (but is not recommended since it assumes a file system that distinguishes and preserves case): https://www.gnu.org/software/make/manual/html_node/Catalogue-of-Rules.html#index-_002eC None of the files seem to actually be C++ code eg VolumeIntegrals_GRMHD/src/perform_integration_sum_global.C contains void VI_GRMHD_DoSum(CCTK_ARGUMENTS) which is not typically used in C++ code (though the required extern “C” is already provided by Cactus' prototype (so that it is actually found by schedule.ccl).

Comments (6)

  1. Roland Haas reporter

    @Zach Etienne this is still the case, ie none of the thorns show up on the website. Documentation should be added even if minimal.

  2. Roland Haas reporter

    @Zach Etienne this is still the case, ie none of the thorns show up on the website. Documentation should be added even if minimal.

  3. Zach Etienne

    @Roland Haas I’ll work with my postdoc @Leonardo Werneck to get these documented (at least minimally) prior to the upcoming release. Please feel free to continue reminding me/us.

  4. Log in to comment