AI Documentation revamp - DRAFT - #2592
Open
willend wants to merge 48 commits into
Open
Conversation
Based on * the two attached McStas usage articles from JNR * the LeX/Yacc grammar definitions and cogen.c in McCode/mccode/src * the mcstas example instruments in McCode/mcstas-comps/examples * the component files in McCode/mcstas-comps/*/*.comp * the commandline interfaces mcrun, mcplot, mcdisplay etc in tools/Python please suggest revisions to update the McStas TeX documentation available in McCode/doc/manuals/mcstas McCode above is my shorthand for this repo location that I gave you file+system access to: [path on my system]
Contributor
Author
|
The failures are a mix of
Now running a set of “nighlies” from this branch to get a more coherent picture. |
… heading in obsolete
Contributor
Author
|
Handheld McXtrace ‘nightly’ output from this branch |
Mention that obsoleted components mentioned in the appendix are in fact obsolete.
… mcxtrace-r.h comments and remove McStas leftovers...
Contributor
Author
|
Here is a McStas ‘nightly’ run based on this PR / branch |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Free-form text area
Please describe what your PR is adding in terms of features or bugfixes:
Declaration of use of AI-tools
I’ve used Claude to double-check static TeX code against component headers (and generated .tex tables).
Also, the parameter unit column was partially vetted and e.g. Å used for AA / Angs / Ang etc. superscript (e.g. ^2) has been converted to LaTeX superscript in the manuals.
The components were touched header-wise to enable coherence wrt. the units.
An updated (DRAFT) set of improved manuals are included with this PR (would still need updated version numbers etc.)
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 patches to an existing component file
My contribution contains something else