| 1 | .TH mcgui 1 "" "McStas X.Y.Z, Month Day, Year" "USER COMMANDS" |
|---|
| 2 | .SH NAME |
|---|
| 3 | mcgui \- graphical user interface of the McStas neutron ray-trace simulation package |
|---|
| 4 | .SH SYNOPSIS |
|---|
| 5 | .B mcgui |
|---|
| 6 | [\-\-open] [file.instr] |
|---|
| 7 | .SH DESCRIPTION |
|---|
| 8 | The |
|---|
| 9 | .B mcgui |
|---|
| 10 | command is the graphical user interface of the McStas package. It has the following features: Loading instruments and editing their descriptions, compiling them, running single simulations, as well as scans of parameters, usage of parallel computation (when available), parameter optimization to maximize monitor values, plotting of simulation results and instrument geometry, access to instrument templates and plenty of documentation. |
|---|
| 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 | .B 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 | 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 | .TP |
|---|
| 59 | file.instr |
|---|
| 60 | loads the specified instrument when starting |
|---|
| 61 | .TP |
|---|
| 62 | \-\-open |
|---|
| 63 | will open the instrument editor window |
|---|
| 64 | .TP |
|---|
| 65 | \-\-edit |
|---|
| 66 | will only open the instrument editor window (no main/simulation window) |
|---|
| 67 | .TP |
|---|
| 68 | \-\-help |
|---|
| 69 | display command help |
|---|
| 70 | .SH EXAMPLES |
|---|
| 71 | .TP |
|---|
| 72 | Typical usage |
|---|
| 73 | .B mcgui |
|---|
| 74 | .TP |
|---|
| 75 | Open the foo.instr instrument |
|---|
| 76 | mcgui foo.instr |
|---|
| 77 | .SH ENVIRONMENT |
|---|
| 78 | The |
|---|
| 79 | .B MCSTAS |
|---|
| 80 | 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. |
|---|
| 81 | The McStas configuration file is MCSTAS/tools/perl/mcstas_config.perl |
|---|
| 82 | .P |
|---|
| 83 | The |
|---|
| 84 | .B MCSTAS_FORMAT |
|---|
| 85 | environment variable may be set to define the default data format used for storing results. This is usually 'PGPLOT', 'Matlab', or 'Scilab'. |
|---|
| 86 | .P |
|---|
| 87 | The |
|---|
| 88 | .B |
|---|
| 89 | MCSTAS_CC |
|---|
| 90 | environment variable may be set to define the compiler to use (e.g. gcc) |
|---|
| 91 | .P |
|---|
| 92 | The |
|---|
| 93 | .B |
|---|
| 94 | MCSTAS_CFLAGS |
|---|
| 95 | environment variable may be set to define the options for compilation (e.g. -O2) |
|---|
| 96 | .P |
|---|
| 97 | The |
|---|
| 98 | .B BROWSER |
|---|
| 99 | environment variable may be set to define the default HTML browser to use |
|---|
| 100 | .SH BUGS |
|---|
| 101 | Some implementations of Perl-Tk do not support desktop switching and windows redraw. This may crash mcgui. |
|---|
| 102 | McStas is a large package, and bugs might be found. If so, please report to |
|---|
| 103 | .B http://mcstas.org/McZilla/ |
|---|
| 104 | and the mailing list |
|---|
| 105 | .B neutron-mc@risoe.dk |
|---|
| 106 | .SH AUTHOR |
|---|
| 107 | Peter Kjaer Willendrup, Emmanuel FARHI, Kim Lefmann, and Klaus Lieutenant |
|---|
| 108 | .SH SEE ALSO |
|---|
| 109 | mcstas(1), mcrun(1), mcdisplay(1), mcplot(1), mcgui(1), mcdoc(1), mcformat(1), mcconvert(1) |
|---|
| 110 | .P |
|---|
| 111 | web site: <http://www.mcstas.org> |
|---|
| 112 | .P |
|---|
| 113 | mailing list: <mailto:neutron-mc@risoe.dk> |
|---|
| 114 | .P |
|---|
| 115 | matlab(1), idl(1), scilab(1), octave(1), vitess(1), NISP(1), restrax(1), mcnp(1), tripoli(1) |
|---|
