.. _simnibs_gui_cli_doc:

simnibs_gui
============

Description
-------------

A graphical user interface for setting up and running simulations. Please see the tutorial on :ref:`gui_tutorial` and the :ref:`gui_docs` for more information.

Usage Example
--------------

* To start the GUI, type in the Command Prompt on Windows (:ref:`more information <windows_terminal>`) or in a *Bash*
  terminal in Linux/MacOSX

  .. code-block:: bash

    simnibs_gui


* When starting the GUI, you can give it a name of a head mesh (*.msh* file) or a simulation
  set-up file (*.mat* file). This way, the GUI will automatically load the head mesh of
  the simulation set-up.

  .. code-block:: bash

    simnibs_gui ernie.msh