% @MCCODE_PREFIX@GUI(1)
% @FLAVOR_UPPER@ @MCCODE_PARTICLE@ Ray Tracing Team
% @MCCODE_DATE@

# NAME

**@MCCODE_PREFIX@gui** - The @MCCODE_NAME@ graphical user interface

# SYNOPSIS

**@MCCODE_PREFIX@gui** [INSTR]

# DESCRIPTION

The front-end **@MCCODE_PREFIX@gui** provides a graphical user interface that interfaces the
various parts of the @MCCODE_NAME@ package. It is started from a shell/command prompt
using simply the command @MCCODE_PREFIX@gui The `@MCCODE_PREFIX@gui` program may optionally be given the
name INSTR of an instrument file. When the front-end is started, a main window
is opened. This window displays the output from compiling and running
simulations, and also contains a few menus and buttons. The main purpose of the
front-end is to edit and compile instrument definitions, run the simulations,
and visualize the results.

# OPTIONS

**INSTR**
:   optional name of the instrument to open.

# FILES

/usr/share/@FLAVOR@/resources
/usr/share/@FLAVOR@/tools/Python/mccodelib/mccode_config.json
~/.@FLAVOR@/mccode_config.json
http://www.@FLAVOR@.org

# EXAMPLES

Open the *Test_SX* example (Single crystal diffraction)
:   - `@MCCODE_PREFIX@gui Test_SX.instr`

# AUTHORS

@MCCODE_NAME@ Team (@FLAVOR@.org)

# SEE ALSO

@FLAVOR@(1), @MCCODE_PREFIX@doc(1), @MCCODE_PREFIX@plot(1), @MCCODE_PREFIX@run(1), @MCCODE_PREFIX@gui(1), @MCCODE_PREFIX@display(1)
