Merge pull request #2341 from willend/main

Add more %Example lines to McStas instruments

Author: willend

mcstas-comps/contrib/SNS_source_analytic.comp

@@ -926,9 +926,6 @@ INITIALIZE
   CL = (1.0 / sqrt (Emin * 1e-3) - 1.0 / sqrt (Emax * 1e-3)) / (Emax - Emin) * 1e3;
   CU = (log (Emax * 1e-3) - log (Emin * 1e-3)) / (Emax - Emin) * 1e3;
 
-  #ifdef USE_MPI
-  p_in /= mpi_node_count;
-  #endif
   p_in /= mcget_ncount ();
 %}
 

mcstas-comps/data/source_sct091_tu_02_1.dat

@@ -16,26 +16,44 @@
 *
 * Simple instrumentfile for estimating SNS brilliance, moderator is a the Gallmeier SNS_source_analytic applying Ikeda-Carpenter vs. Pade function fits to MCNPX tables.
 *
+* %Example: filename=a1Gw2-2-f5_fit_fit.dat Detector: Brillmon_I=5.51519e+12
+*
 * %Parameters
 * Lambda_min: [AA] Minimum wavelength produced at source
 * Lambda_max: [AA] Maximum wavelength produced at source
+* filename:  [str] Source input file from $MCSTAS/data
 *
 * %Link
 *
 * %End
 *******************************************************************************/
-DEFINE INSTRUMENT Gallmeier_SNS_decoupled_poisoned(Lambda_min=0.5,Lambda_max=20)
+DEFINE INSTRUMENT Gallmeier_SNS_decoupled_poisoned(Lambda_min=0.5,Lambda_max=20, string filename="a1Gw2-2-f5_fit_fit.dat")
 
+DEPENDENCY " -DLOADPATH=GETPATH(data) "
+  
 DECLARE
 %{
   double E_min;
   double E_max;
+  char fullfile[256];
 %}
 
 INITIALIZE
 %{
   E_min=81.82/(Lambda_max*Lambda_max);
   E_max=81.82/(Lambda_min*Lambda_min);
+
+  #define QUOTE(x) #x
+  #define STR(macro) QUOTE(macro)
+
+  #ifndef LOADPATH
+  #define LOADPATH /usr/share/mcstas/data
+  #endif
+
+  #define LOADPATH_ STR(LOADPATH)
+  
+  sprintf(fullfile,"%s/%s",LOADPATH_,filename);
+
 %}
 
 /* Here comes the TRACE section, where the actual      */
@@ -45,7 +63,7 @@ TRACE
 COMPONENT Origin = Progress_bar()
   AT (0,0,0) ABSOLUTE
 
-  COMPONENT Source = SNS_source_analytic(filename="a1Gw2-2-f5_fit_fit.dat",
+  COMPONENT Source = SNS_source_analytic(filename=fullfile,
 			      xwidth=0.01, yheight=0.01,
 			      dist=1, focus_xw=0.01, focus_yh=0.01, Emin=E_min,Emax=E_max,sample_E=2, p_power=2)
  AT (0,0,0) ABSOLUTE

mcstas-comps/examples/SNS/Gallmeier_SNS_decoupled_poisoned/Gallmeier_SNS_decoupled_poisoned.instr

@@ -16,26 +16,44 @@
 *
 * Simple instrumentfile for estimating SNS brilliance, moderator is a the Granroth SNS_source applying linear interpolation in MCNPX tables.
 *
+* %Example: filename=source_sct091_tu_02_1.dat Detector: Brillmon_I=7.11736e+12
+*
 * %Parameters
 * Lambda_min: [AA] Minimum wavelength produced at source
 * Lambda_max: [AA] Maximum wavelength produced at source
+* filename:  [str] Source input file from $MCSTAS/data
 *
 * %Link
 *
 * %End
 *******************************************************************************/
-DEFINE INSTRUMENT Granroth_SNS_decoupled_poisoned(Lambda_min=0.5,Lambda_max=20)
+DEFINE INSTRUMENT Granroth_SNS_decoupled_poisoned(Lambda_min=0.5,Lambda_max=20, string filename="source_sct091_tu_02_1.dat")
 
+DEPENDENCY " -DLOADPATH=GETPATH(data) "
+  
 DECLARE
 %{
   double E_min;
   double E_max;
+  char fullfile[256];
 %}
 
 INITIALIZE
 %{
   E_min=81.82/(Lambda_max*Lambda_max);
   E_max=81.82/(Lambda_min*Lambda_min);
+
+  #define QUOTE(x) #x
+  #define STR(macro) QUOTE(macro)
+
+  #ifndef LOADPATH
+  #define LOADPATH /usr/share/mcstas/data
+  #endif
+
+  #define LOADPATH_ STR(LOADPATH)
+  
+  sprintf(fullfile,"%s/%s",LOADPATH_,filename);
+
 %}
 
 /* Here comes the TRACE section, where the actual      */
@@ -45,7 +63,7 @@ TRACE
 COMPONENT Origin = Progress_bar()
   AT (0,0,0) ABSOLUTE
 
-COMPONENT Source = SNS_source(filename="/usr/local/lib/mcstas-2.0delta/data/source_sct091_tu_02_1.dat",
+COMPONENT Source = SNS_source(filename=fullfile,
 			      xwidth=0.01, yheight=0.01,
 			      dist=1, focus_xw=0.01, focus_yh=0.01, Emin=E_min,Emax=E_max)//,sample_E=samp, p_power=0.5)
  AT (0,0,0) ABSOLUTE

mcstas-comps/examples/SNS/Granroth_SNS_decoupled_poisoned/Granroth_SNS_decoupled_poisoned.instr

@@ -16,6 +16,8 @@
 *
 * Simple instrumentfile for estimating SNS brilliance, moderator is a rescaled ESS short-pulsed Mezei description.
 *
+* %Example: -y Detector: Brillmon_I=1.178e+13
+*
 * %Parameters
 * Lambda_min: [AA] Minimum wavelength produced at source
 * Lambda_max: [AA] Maximum wavelength produced at source

mcstas-comps/examples/SNS/Mezei_SNS_decoupled_poisoned/Mezei_SNS_decoupled_poisoned.instr

@@ -24,6 +24,8 @@
 * B. Fultz,"Design and operation of the wide angular-range chopper spectrometer ARCS at the
 * Spallation Neutron Source", Review of Scientific Instruments, 83 , 015114 (2012)</ul>
 *
+* %Example: -y Detector: Full_cyl_I=235445
+*
 * %Parameters
 * Fermi_nu: [Hz]  Frequency of the Fermi chopper
 * T0_nu: [Hz]     Frequency of the T0 chopper
@@ -260,7 +262,12 @@ AT(0,0,LS)  RELATIVE mod
 COMPONENT sampleMantid = Spot_sample(radius_o=0.01, h=0.05, pack = 1,xwidth=0, yheight=0, zthick=0, Eideal=Edes,w=Et,two_theta=ttheta,n_spots=4)
 AT (0.0,0.0,0.0) RELATIVE Sample_Arm
 
-  COMPONENT  t_mon_detB= Monitor_nD(xwidth=5.9817,yheight=3.2,restore_neutron=1, filename="this",
+COMPONENT Full_cyl= Monitor_nD(xwidth=5.98,yheight=3.2,restore_neutron=1,
+                          options="mantid banana, theta limits=[-28.0 135.38] bins=389 ,y limits=[-0.550 0.450] bins=128")
+AT (0,0,0.00005) RELATIVE Sample_Arm
+
+
+COMPONENT  t_mon_detB= Monitor_nD(xwidth=5.9817,yheight=3.2,restore_neutron=1, filename="this",
                           options="mantid banana, theta limits=[-28.0 135.38] bins=389 ,y limits=[-0.550 0.450] bins=128, neutron pixel min=0 t, list all neutrons", restore_neutron=1)
 AT (0,0,0.00005) RELATIVE Sample_Arm
 

mcstas-comps/examples/SNS/SNS_ARCS/SNS_ARCS.instr

@@ -19,7 +19,7 @@
 * Simple test instrument for the SNS_source component.
 * Refer to SNS <A href="http://neutrons.ornl.gov/instrument_systems/components/moderators.shtml">Source files.</A>
 *
-* Example: filename="source_sct091_tu_02_1.dat" Detector: det_I=9.89304e+09
+* Example: filename=source_sct091_tu_02_1.dat Detector: det_I=7.09416e+09
 *
 * %Parameters
 * filename: [string] Source file 

mcstas-comps/examples/SNS/SNS_analytic_test/SNS_analytic_test.instr

@@ -23,7 +23,9 @@
 * These parameter and the sphere radius match now with the magnetic fields below to get a good measurement range.
 * A pretty high number of neutrons is needed to get good statistics in the fine position sensitive detector.
 *
-* Example: 
+* %Example: -y Detector: det_I=7.8145e-08
+*
+* Other examples: 
 * SESANS_Delft -n 100000000 -N 31 L0=2.165 DL=0.02 By=0,0.0468 AnaSign=1
 * SESANS_Delft -n 100000000 -N 31 L0=2.165 DL=0.02 By=0,0.0468 AnaSign=-1
 *

mcstas-comps/examples/TUDelft/SEMSANS_Delft/SEMSANS_Delft.instr

@@ -14,6 +14,8 @@
 * %Description
 * SEMSANS instrument with 2 isosceles triangular field coils
 *
+* %Example: -y Detector: TOF_det_I=2.87073e-09
+*
 * %Parameters
 * triacoil_depth: [m]   Half of the triangular coil depth in z-direction (one right triangle)
 * triacoil_width: [m]   xwidth of triangular coil

mcstas-comps/examples/TUDelft/SEMSANS_instrument/SEMSANS_instrument.instr

@@ -22,7 +22,9 @@
 * The foil-angle, thickness and wavelength yield now matched parameters to have the SESANS working. 
 * These parameter and the sphere radius match now with the magnetic fields below to get a good measurement range.
 *
-* Example: SESANS_Delft -n 1000000 -N 31 L0=2.165 DL=0.02 By=0,0.0468
+* %Example: -y Detector: det_I=2.2537e-07
+* 
+* Scan Example: SESANS_Delft -n 1000000 -N 31 L0=2.165 DL=0.02 By=0,0.0468
 *
 * %P
 * <parameter1>: [<unit>] <parameter1 description>