Please describe what your PR is adding in terms of features or bugfixes:
- Please add a checkmark here if you used AI-tools during the work for this contribution
- Further, please describe how / where and for what the tools were used:
- AI-assisted commits must carry a
Co-Authored-Byline naming the tool, see CONTRIBUTING.md
Please describe what OS you developed and tested your additions on, and if any special dependencies are required:
For a coherent and useful contribution to McStas/McXtrace, please fill in relevant parts of the checklist:
-
- I have used the
mcdocutility and rendered a reasonable documentation page for the component (please attach as screenshot in comments!) - I have ensured that basic use of the component is OK (e.g. an instrument using it compiles?)
- I have used the
mctestutility to test one or more instruments making use of the component (please attachmcviewtestreport as screenshot in comments) - I have used the
mccode-clangformattool to apply the standard McCode component indentation scheme - I have used the
mcrun --c-lint"linter" and followed advice to remove most / all warnings that are raised
- I have used the
-
- I have used the
mcdocutility and rendered a reasonable documentation page for the instrument (please attach as screenshot in comments!) - I have used the
mctestutility to test the instrument (please attachmcviewtestreport as screenshot in comments) - I have used the
mcrun --c-lint"linter" and followed advice to remove most / all warnings that are raised
- I have used the
-
- I have ensured that naming of parameters are in the style of existing components. (Please check the McStas or McXtrace NOMENCLATURE docs.)
- I have ensured that component parameters are in the usually units of McStas or McXtrace (SI + neutron/x-ray 'usual' units)
- I have used the
mcdocutility and rendered a reasonable documentation page for the component (please attach as screenshot in comments!) - I have ensured that basic use of the component is OK (e.g. an instrument using it compiles?)
- I have included a corresponding example instrument and will fill in the new instrument section below
- I have used the
mccode-clangformattool to apply the standard McCode component indentation scheme - My new component is added within the
contribcomponent category
-
- I have used the
mcdocutility and rendered a reasonable documentation page for the instrument (please attach as screenshot in comments!) - I have ensured that basic use of the instrument is OK (e.g. it compiles?)
- ... and provided reasonable default parameters in that instrument that produce reasonable output
- ... and maybe even added a
%Test:line (or a%TestScan:line for a parameter scan) to describe expected behaviour - I have used the
mcrun --c-lint"linter" and followed advice to remove most / all warnings that are raised - My new instrument is added within the
exampleshierarchy in a folder in the style ofexamples/ESS/New_stuff/New_stuff.instr - My new instrument has a new, unique filename, not clashing with existing example instruments
- My new instrument requires a data/input file. If the datafile is specific for my instrument I have left it in the same
examplefolder, but if general use I have placed it in the globaldatafolder.
- I have used the
-
- I have added reasoning and documentation for the change through an ADR record in our GRAMMAR section
- I am attaching test output in the comments
-
- I have added reasoning and documentation for the change below
- I am attaching test output in the comments
- Unit test: every new or changed
common/lib/share,mccode/nlib/share,mcstas-comps/shareormcxtrace-comps/sharelibrary and runtime file (.c,.h,.h.in) has aTest_lib_<name>instrument inexamples/libtest/(McStas and/or McXtrace), with a%Test:line where the result can be checked. If it cannot be standalone, say why in the free-form text (e.g. needs a component or external package)
-
- I have indicated the issue number here:
- I have added documentation for the fix and possible side effects
-
- Explanation is added in free form text above or below the checklist