McCode icon indicating copy to clipboard operation
McCode copied to clipboard

Increase "example-coverage" of comps in McStas and McXtrace - status

Open willend opened this issue 7 months ago • 0 comments

A (quick+dirty bash-) tool has been written to investigate our level of "example-documentation" for the components of McStas and McXtrace (compmatrix.sh in mcstas-comps/ and mcxtrace-comps/).

Sasmodels and obsolete are disregarded in the below lists since:

  • The obsolete comps are supposed to be obsolete
  • ~90 extra sasmodel-examples would be a bit much...

These are the current lists of components that are not covered by examples. https://github.com/McStasMcXtrace/McCode/blob/main/mcstas-comps/comps_no_examples.txt (15 in contrib, 4/5 in misc, 9/10 in monitors, 2 in optics, 0 in samples, 3 in sources, 4/6 in union - not all relevant)

https://github.com/McStasMcXtrace/McCode/blob/main/mcxtrace-comps/comps_no_examples.txt (4 in astrox, 3 in contrib, 3 in misc, 8 in monitors, 2 in optics, 0 in samples, 2 in sources, 1 in union)

willend avatar Jan 05 '24 14:01 willend