From: Matthias Maier Date: Wed, 6 Jul 2016 20:54:41 +0000 (-0500) Subject: Rewrite README in markdown X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=095865bcdc457dfbb5eb3d59cf6ea5d3e725a453;p=parameter_gui.git Rewrite README in markdown --- diff --git a/README b/README deleted file mode 100644 index 7c876f9..0000000 --- a/README +++ /dev/null @@ -1,5 +0,0 @@ -This repository contains the parameter_gui project. - -It is copyrighted by Martin Steigemann and Wolfgang Bangerth and -distributed under the same license as the deal.II library, i.e. -The GNU Lesser General Public License (LGPL) version 2.1 or later. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9a10d76 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# This repository contains the parameter_gui project. + +It is copyrighted by Martin Steigemann and Wolfgang Bangerth and +distributed under the same license as the deal.II library, i.e. The GNU +Lesser General Public License (LGPL) version 2.1 or later. + +Usage: +====== + +To use the parameter GUI you first need to write a description of all the +parameters, their default values, patterns and documentation strings into a +file in a format that the GUI can understand; this is done using the +ParameterHandler::print_parameters() function with ParameterHandler::XML as +second argument, as discussed in more detail below in the Representation +of Parameters section. This file can then be loaded using the +executable for the GUI, which should be located in +lib/bin/dealii_parameter_gui of your deal.II installation, +assuming that you have a sufficiently recent version of the Qt toolkit installed. + +Once loaded, the GUI displays subsections and individual parameters in tree +form (see also the discussion in the Representation of Parameters +section below). Here is a screen shot with some sub-sections expanded and +one parameter selected for editing: + +![Paremeter GUI](parameter_gui.png) + +Using the GUI, you can edit the values of individual parameters and save +the result in the same format as before. It can then be read in using the +ParameterHandler::read_input_from_xml() function. diff --git a/parameter_gui.png b/parameter_gui.png new file mode 100644 index 0000000..204eab6 Binary files /dev/null and b/parameter_gui.png differ