Skip to content

add --injectionSourcesHelp to MFDv5, CFSv2, HSGCT

David Keitel requested to merge david-keitel/lalsuite:injectionSourcesHelp into master

As has long been requested (https://git.ligo.org/CW/software/lalsuite/issues/37 and even before, in Redmine days):

add --injectionSourcesHelp to MFDv5, CFSv2, HSGCT
 -shared function XLALPrintInjectionSourcesHelp()
 -by no means complete, but should be good enough
  to get most people started on the standard features
 -refs https://git.ligo.org/CW/software/lalsuite/issues/37

@karl-wette : I thought about more elegant implementations, and in principle one could try amending the UserInput module to make any option including the substring "help" break the parsing early, or (more safely) provide a special type to do so, or something like that. While the semi-manual way I have for now implemented makes it incompatible with required options, see the small workaround in HSGCT. But I wanted to keep it simple. Let me know if there's a more elegant, and not particularly invasive to UserInput, way.

Apart from that, I've noted in both the helper function and the actual output that the documentation isn't complete. But I think "perfect is the enemy of good" is the main reason this request has been open for years, and it'd be good to have this baseline doc for now, and future improvements can of course be done.

Merge request reports