From fc84900642de020087972198ce28cc7d0d224e60 Mon Sep 17 00:00:00 2001 From: Peter Willendrup Date: Wed, 9 Sep 2026 15:26:20 +0200 Subject: [PATCH 1/2] Doc header was not complete. --- .../examples/Tests_grammar/Unittest_SPLIT_sample/README.md | 4 ++-- .../Unittest_SPLIT_sample/Unittest_SPLIT_sample.instr | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/mcstas-comps/examples/Tests_grammar/Unittest_SPLIT_sample/README.md b/mcstas-comps/examples/Tests_grammar/Unittest_SPLIT_sample/README.md index eac564a2bf..ed513387aa 100644 --- a/mcstas-comps/examples/Tests_grammar/Unittest_SPLIT_sample/README.md +++ b/mcstas-comps/examples/Tests_grammar/Unittest_SPLIT_sample/README.md @@ -41,9 +41,9 @@ Parameters in **boldface** are required; the others are optional. | Name | Unit | Description | Default | |------|------|-------------|---------| -| SAMPLE | | | 1 | +| SAMPLE | 1 | 1=Incoherent, 2=PowderN(Al.lau), 3=Single_crystal(Al.lau) | 1 | | SPLITS | 1 | Number of SPLIT to do | 10 | -| Pp0 | 1 | Dummy input parameter used internally | 1 | +| Pp0 | 1 | Dummy input parameter used internally for ensuring unit evennt weight | 1 | ## Links diff --git a/mcstas-comps/examples/Tests_grammar/Unittest_SPLIT_sample/Unittest_SPLIT_sample.instr b/mcstas-comps/examples/Tests_grammar/Unittest_SPLIT_sample/Unittest_SPLIT_sample.instr index 07a53582d0..935620897a 100644 --- a/mcstas-comps/examples/Tests_grammar/Unittest_SPLIT_sample/Unittest_SPLIT_sample.instr +++ b/mcstas-comps/examples/Tests_grammar/Unittest_SPLIT_sample/Unittest_SPLIT_sample.instr @@ -32,8 +32,9 @@ * %Example: SAMPLE=3 SPLITS=100 Detector: PSD_scattered_I=0.182056 * * %P +* SAMPLE: [1] 1=Incoherent, 2=PowderN(Al.lau), 3=Single_crystal(Al.lau) * SPLITS: [1] Number of SPLIT to do -* Pp0: [1] Dummy input parameter used internally +* Pp0: [1] Dummy input parameter used internally for ensuring unit evennt weight * * %L * From c3bdd3c11006f87f5735e84faf90e4bafd966444 Mon Sep 17 00:00:00 2001 From: Peter Willendrup Date: Wed, 9 Sep 2026 15:27:21 +0200 Subject: [PATCH 2/2] Adding missing README.md's for two instruments --- .../elearning/Radiography_Sword/README.md | 45 +++++++++++++++++++ .../Tests_optics/Test_Filter_geom/README.md | 41 +++++++++++++++++ 2 files changed, 86 insertions(+) create mode 100644 mcstas-comps/examples/elearning/Radiography_Sword/README.md create mode 100644 mcxtrace-comps/examples/Tests_optics/Test_Filter_geom/README.md diff --git a/mcstas-comps/examples/elearning/Radiography_Sword/README.md b/mcstas-comps/examples/elearning/Radiography_Sword/README.md new file mode 100644 index 0000000000..2025a306a3 --- /dev/null +++ b/mcstas-comps/examples/elearning/Radiography_Sword/README.md @@ -0,0 +1,45 @@ +# The `Radiography_Sword` Instrument + +*McStas: Viking Sword in Radiography instrument. Developed for PaNOSC (EU H2020 GA No. 823852).* + +## Identification + +- **Site:** elearning +- **Author:** Mads Bertelsen and Viktor L. Holm +- **Origin:** University of Copenhagen +- **Date:** August 2019 + +## Description + +```text +This is a simulation of bragg-edge imaging preformed on a viking sword at an imaging beamline. Developed for PaNOSC (EU H2020 GA No. 823852). +The beam delivered from the source approximates that of the ODIN instrument at ESS and the model is meant for educational purposes. +``` + +## Examples + +- **Test: Radiography_Sword -y Detector: screen_I=4.34897e+15** + +## Input parameters + +Parameters in **boldface** are required; the others are optional. + +| Name | Unit | Description | Default | +|------|------|-------------|---------| +| chopper_mode | 1 | Choose between 6 different chopper modes from 0 to 5. Chooper mode 5 is a white beam. | 5 | +| Lambda | AA | Choose a specific wavelength 1AA-10AA to use in the simulation. The wavelength must correspond to choosen chopper mode. Lambda=0 means that all wavelengths permitted by the chopper mode are used. | 0 | +| Sample | 0 | Choose if the sample is pressent in the simulation or not, Sample=0: not in the beam, Sample=1: sample is in the beam. | 1 | +| pinhole_diameter | m | Diameter of the pinhole. Allowed sizes are 0.01-0.1m. | 0.1 | +| pinhole_detector_distance | m | Distance between the pinhole and the detector. Allowed distances are 10m-25m. | 10.0 | +| pinhole_sample_distance | m | Distance between the pinhole and the sample. Allowed distances are between 1-25m. | 9 | +| X_sample_pos | m | Translation of sample in x-direction. | 0.0 | +| Y_sample_pos | m | Translation of sample in x-direction. | 0.0 | +| angle | deg | Sample-stage rotation (around y). | 0 | +| Zoom | 1 | Detector zooom: Reduce area and increase resolution detector by the same fact. Values between 1 and 10. | 1 | + +## Links + +- [Source code](Radiography_Sword.instr) for `Radiography_Sword.instr`. +- Originally developed for the PaNOSC e-learning portal + +--- diff --git a/mcxtrace-comps/examples/Tests_optics/Test_Filter_geom/README.md b/mcxtrace-comps/examples/Tests_optics/Test_Filter_geom/README.md new file mode 100644 index 0000000000..69075ead6e --- /dev/null +++ b/mcxtrace-comps/examples/Tests_optics/Test_Filter_geom/README.md @@ -0,0 +1,41 @@ +# The `Test_Filter_geom` Instrument + +*McXtrace: Test instrument for checking the geometry options of the Filter.comp component* + +## Identification + +- **Site:** Tests_optics +- **Author:** Erik Knudsen (erkn@risoe.dtu.dk) +- **Origin:** Risø DTU +- **Date:** July 5th 2011 + +## Description + +```text +Test instrument for checking the Filter.comp component +Specifically this instrument checks the geometry options and refraction +``` + +## Examples + + + +## Input parameters + +Parameters in **boldface** are required; the others are optional. + +| Name | Unit | Description | Default | +|------|------|-------------|---------| +| filter_mat | | Chemical symbol of the filter material | "Rh.txt" | +| thickness | m | thickness of the filter block | 100e-6 | +| L0 | AA | centre wavlength of the source | 1 | +| DL | AA | half width of the (uniform) wavelength distribution | 0.1 | +| F2 | 1 | add a 2nd filter component further away | 0 | +| shape | | | 0 | +| refraction | | | 0 | + +## Links + +- [Source code](Test_Filter_geom.instr) for `Test_Filter_geom.instr`. + +---