| 1 | .TH mcdoc 1 "" "McStas X.Y.Z, Month Day, Year" "USER COMMANDS" |
|---|
| 2 | .SH NAME |
|---|
| 3 | mcdoc \- documentation tool of the McStas neutron ray-trace simulation package |
|---|
| 4 | .SH SYNOPSIS |
|---|
| 5 | .B mcdoc |
|---|
| 6 | [\-mc] [comp|instr] |
|---|
| 7 | .SH DESCRIPTION |
|---|
| 8 | The |
|---|
| 9 | .B mcdoc |
|---|
| 10 | command is the documentation tool of the McStas package. It opens a browser to display help ressources. |
|---|
| 11 | .PP |
|---|
| 12 | .B McStas |
|---|
| 13 | is a general tool for simulating neutron scattering instruments and experiments. It is actively supported by |
|---|
| 14 | .I Risoe National Laboratory |
|---|
| 15 | and |
|---|
| 16 | .I ILL |
|---|
| 17 | |
|---|
| 18 | .PP |
|---|
| 19 | McStas is based on a compiler [mcstas(1)] that reads a high-level specification language defining the instrument to be simulated and produces C code that performs the Monte Carlo Simulation. The system is very fast in use, both when setting up the instrument definition and when doing calculations. |
|---|
| 20 | .PP |
|---|
| 21 | McStas supports triple-axis, time-of-flight instruments, and polarised neutrons. It comes with a comprehensive manual and a library of well-tested components that include most standard elements of neutron scattering instruments, including steady-state and pulsed sources, monochromators/analysers, guides, collimators, vanadium and powder samples, velocity selectors and choppers, and a variety of detectors. |
|---|
| 22 | .PP |
|---|
| 23 | The package consists of the following user commands: |
|---|
| 24 | .TP |
|---|
| 25 | mcgui(1) |
|---|
| 26 | is the graphical user interface. Then use the |
|---|
| 27 | .I Neutron Site |
|---|
| 28 | menu to select an example instrument, and access the whole documentation for the |
|---|
| 29 | .I Help |
|---|
| 30 | menu. It contains an instrument editor, methods to plot simulation results, and much more |
|---|
| 31 | .TP |
|---|
| 32 | mcrun(1) |
|---|
| 33 | is the command-line tool for building and running simulations |
|---|
| 34 | .TP |
|---|
| 35 | mcplot(1) |
|---|
| 36 | is the simulation results plotting tool |
|---|
| 37 | .TP |
|---|
| 38 | mcdisplay(1) |
|---|
| 39 | is the instrument geometry and neutron trajectory viewer |
|---|
| 40 | .TP |
|---|
| 41 | .B mcdoc(1) |
|---|
| 42 | is the documentation tool |
|---|
| 43 | .TP |
|---|
| 44 | mcstas(1) |
|---|
| 45 | is the instrument compiler |
|---|
| 46 | .TP |
|---|
| 47 | mcconvert(1) |
|---|
| 48 | can convert Matlab data files into Scilab data files, and vice-versa. It also handles data sets with binary encoding. It also handles parameter scan results. |
|---|
| 49 | .TP |
|---|
| 50 | mcformat(1) |
|---|
| 51 | can transform any text data set from one format to an other. It does not support conversion from binary data sets. It can also merge equivalent results. |
|---|
| 52 | .PP |
|---|
| 53 | We encourage users to refer to the User and Component Manuals, which are available with the command |
|---|
| 54 | .B |
|---|
| 55 | mcdoc |
|---|
| 56 | .P |
|---|
| 57 | .SH OPTIONS |
|---|
| 58 | The usage of the command does not require option. Refer to mcplot \-h for special uses. |
|---|
| 59 | .TP |
|---|
| 60 | \-h | \-\-help |
|---|
| 61 | displays the command help |
|---|
| 62 | .TP |
|---|
| 63 | \-c |
|---|
| 64 | opens the Component manual |
|---|
| 65 | .TP |
|---|
| 66 | \-m |
|---|
| 67 | opens the User manual |
|---|
| 68 | .SH EXAMPLES |
|---|
| 69 | .TP |
|---|
| 70 | Typical usage |
|---|
| 71 | .B mcdoc |
|---|
| 72 | .SH ENVIRONMENT |
|---|
| 73 | The |
|---|
| 74 | .B MCSTAS |
|---|
| 75 | environment variable may be set to define the McStas library location. This is /usr/local/lib/mcstas on Linux systems. Executables are usually located in /usr/local/bin. |
|---|
| 76 | .P |
|---|
| 77 | The |
|---|
| 78 | .B BROWSER |
|---|
| 79 | environment variable may be set to define the default HTML browser to use |
|---|
| 80 | .SH BUGS |
|---|
| 81 | McStas is a large package, and bugs might be found. If so, please report to |
|---|
| 82 | .B http://mcstas.org/McZilla/ |
|---|
| 83 | and the mailing list |
|---|
| 84 | .B neutron-mc@risoe.dk |
|---|
| 85 | .SH AUTHOR |
|---|
| 86 | Peter Kjaer Willendrup, Emmanuel FARHI, Kim Lefmann, and Klaus Lieutenant |
|---|
| 87 | .SH SEE ALSO |
|---|
| 88 | mcstas(1), mcrun(1), mcdisplay(1), mcplot(1), mcgui(1), mcdoc(1), mcformat(1), mcconvert(1) |
|---|
| 89 | .P |
|---|
| 90 | web site: <http://www.mcstas.org> |
|---|
| 91 | .P |
|---|
| 92 | mailing list: <mailto:neutron-mc@risoe.dk> |
|---|
| 93 | .P |
|---|
| 94 | matlab(1), idl(1), scilab(1), octave(1), vitess(1), NISP(1), restrax(1), mcnp(1), tripoli(1) |
|---|
