Skip to content

New spin wave comp#2373

Open
SSBNS wants to merge 16 commits intomccode-dev:mainfrom
SSBNS:new_SpinWave_comp
Open

New spin wave comp#2373
SSBNS wants to merge 16 commits intomccode-dev:mainfrom
SSBNS:new_SpinWave_comp

Conversation

@SSBNS
Copy link
Copy Markdown

@SSBNS SSBNS commented Mar 27, 2026

Free-form text area

Please describe what your PR is adding in terms of features or bugfixes:
I am adding the SpinWave_BCO component to the sample library. as well as a test instrument in examples.


Development OS / boundary conditions

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


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

SSBNS and others added 5 commits November 10, 2025 13:52
Changed focus_aw and focus_ah from deg to rad to comply with randvec_target_angular.
Added both component to contrib and test instrument to examples
@SSBNS
Copy link
Copy Markdown
Author

SSBNS commented Mar 27, 2026

@willend
Copy link
Copy Markdown
Contributor

willend commented Apr 8, 2026

@SSBNS I’ve started looking at your component which looks mostly nice - I have done a little my self by now:

  • I’ve done a little cosmetics on the doc header
  • I have removed the repo “top level” instr file - the “best” one is correctly placed under the mcstas-comps/examples

There are a few remaining things I would like you to rectify before inclusion:

  • I’ve added a couple of PLEASE sentences in the comp doc header - please fill in / adapt for
    • Fq (description missing)
    • Spin (please elaborate)
  • Just a matter of style, but aren’t coupling constants often with capital J ’s?

Will take another look at your instr file also.

@willend
Copy link
Copy Markdown
Contributor

willend commented Apr 8, 2026

Oh and yes one more thing - it looks like you may have (by mistake, likely) touched Phonon_simple also, will put the version from main in place to keep things as clear as possible.

willend added 2 commits April 8, 2026 15:57
* Remove commented monitor-instances
* Remove -n specifiers in %Example lines
* Add <sup>-1</sup> html syntax in header
@willend
Copy link
Copy Markdown
Contributor

willend commented Apr 8, 2026

I did minor rectifications to the instr header also + removed “dead” comp instances

@willend
Copy link
Copy Markdown
Contributor

willend commented Apr 8, 2026

… and finally I have run the clangformat tool from devel/bin (whitespace-styling mostly)

@willend
Copy link
Copy Markdown
Contributor

willend commented Apr 8, 2026

Another addition to the wish-list:

  • Please fill in the remaining doc strings in the example instr

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.

2 participants