Skip to content

Experimental: Incoming mcvine sample-kernels and detector-comps - #2686

Closed
willend wants to merge 5 commits into
mainfrom
incoming-mcvine-kernels
Closed

willend wants to merge 5 commits into
mainfrom
incoming-mcvine-kernels

Conversation

@willend

@willend willend commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Free-form text area

Please describe what your PR is adding in terms of features or bugfixes:


Declaration of use of AI-tools

  • Please add a checkmark here if you used AI-tools during the work for this contribution
  • Furter, please describe how / where and for what the tools were used:

Will fully document the set of prompts as an attachment. Unfortunately managed to loose the full chat history, sorry about that... Here are analysis-.md files from Claude:

McVine_non-phonon_sample_port.md
McVine_phonon_single_xtal_port.md


Development OS / boundary conditions

Please describe what OS you developed and tested your additions on, and if any special dependencies are required:


PR Checklist for contributing to McStas/McXtrace

For a coherent and useful contribution to McStas/McXtrace, please fill in relevant parts of the checklist:

  • My contribution includes a new component file

    • 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 mcdoc utility 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-clangformat tool to apply the standard McCode component indentation scheme
    • My new component is added within the contrib component category
  • My contribution includes a new instrument file

    • I have used the mcdoc utility 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 %Example: line 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 examples hierarchy in a folder in the style of examples/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 example folder, but if general use I have placed it in the global data folder.
  • My contribution contains something else

    • Explanation is added in free form text above or below the checklist

@willend
willend marked this pull request as draft September 23, 2026 16:39
@willend

willend commented Sep 23, 2026

Copy link
Copy Markdown
Contributor Author

@Fahima-Islam @peterfpeterson @granrothge @huegle

Fahima and I had a chat over lunch today about attempting to port McVine kernels to McStas via LLM. Here is a first draft that I made using Claude, includes

  • sample-kernels that would supplement current McStas capabilities
  • detector-modules

We should discuss if this is the way to move forward - or if we e.g. want a separate repo for these files.

@willend

willend commented Sep 30, 2026

Copy link
Copy Markdown
Contributor Author

Superseeded by #2716

@willend willend closed this Sep 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant