Next: 4. Developer Documentation Up: sciparam-manual Previous: 2. Installing SciParam
Subsections


3. SciParam GUI

3.1 Feature List

Parameter entry fields:
for different types of values
float values
are numbers, which can can be limited to ranges which specify a usual range (see 3.2.5) and/or a valid range (see 3.2.6). Ranges can be specified in scientific notation, e.g. ]-oo;1.2E5] for a range from minus infinity upto and including 120000.

distributed values
are like float numbers, but you can optionally have distribution type (see 3.2.7) like normal, log-normal or uniform.

integer values
can have ranges like float number, too.

strings
can contain any characters.

choices
allow to select a value with radiobuttons or from a drop down list (see 3.2.8).

Details on values:
A special details box (see 3.2.3) provides helpful information on a currently focused entry.

Default values:

For each entry a default can be specified, which is visible in the details box (see 3.2.3). A button allows to apply the default to the current entry.

Comment:
It is possible to enter a comment for the current entry in the details box (see 3.2.3).

Status ``unknown'':
For any value it is possible to enter the status ``unknown'' by deleting the current value. This avoids concepts where a special and potentially misinterpreted number represents an unknown value.

Status ``required'':
A small cross (``sign here''; see 3.2.4) informs about whether a parameter is necessary in a certain context (e.g. to complete a parameter set for a simulation equation). Giving a value here is not forced by the GUI, since this is only an indicator.

3.2 Screenshots

3.2.1 Dialog

This dialog is created by running python dialog.py from inside the SciParam/UI directory:

\includegraphics[scale=1]{screenshots/dialog.eps}

Fig. 3..1: SciParam Dialog

3.2.2 Notebook

This dialog is created by running python notebook.py from inside the SciParam/UI directory:

\includegraphics[scale=1]{screenshots/notebook.eps}

Fig. 3..2: SciParam Notebook


3.2.3 Detailed Information

A box will show additional details for the currently selected parameter. Here you see the parameter ``Volume'' with a long description ``Volume of used samples''. It only allows float values greater or equal zero up to infinity.

There was no distribution active, but now the user selected ``uniform'', therefore a new dialog shows up which asks for the maximum value.

The user already noted a comment to the value he's typing now, so nobody should wonder where it came from.

Using the ``Apply Default'' button, you can also set this value to a default value, which would be 2;20/uniform in this case. This long format of ``value;distribution parameter/distribution type'' can be used in the input field, too, to save the user from putting his hands away from the keyboard to the mouse.

\includegraphics[scale=1]{screenshots/details.eps}

Fig. 3..3: Details Box


3.2.4 Required Parameters

The small cross indicates that this is a required parameter:

\includegraphics[scale=1]{screenshots/required.eps}

Fig. 3..4: Required Parameter


3.2.5 Usual Ranges

If you enter a value which is theoretically possible, but usually wrong (like an atomic number far higher than any known chemical element's number), the input field changes its color to yellow as soon as you leave the input field.

If you try to save this value using the ``OK'' button or switch to another notebook page, a warning dialog asks if you really want to use this value. The input field will stay yellow to warn you, even if you confirm this value, but the warning dialog will only appear again if you change the value.

\includegraphics[scale=1]{screenshots/usualrange.eps}

Fig. 3..5: Outside Usual Range


3.2.6 Valid Ranges

If you enter a value which is outside the valid range (like less than -273.15C for a temperature), the input field changes its color to red as soon as you leave the input field.

If you try to save this value using the ``OK'' button or switch to another notebook page, an error dialog forces you to either enter a correct value or discard changes using the ``Cancel'' button.

\includegraphics[scale=1]{screenshots/validrange.eps}

Fig. 3..6: Outside Valid Range


3.2.7 Distributed Parameters

When choosing a distribution type, a small dialog asks for additional parameters like standard deviation or maximum value. Illegal values for these parameters will be rejected:

\includegraphics[scale=1]{screenshots/distribution.eps}

Fig. 3..7: Distributed Parameter


3.2.8 Choice Parameters

If you have a short list of choices, you can select one of them using radiobuttons. Choices include questions like Yes/No, or selecting one of few values like 3/5/7 meters.

\includegraphics[scale=1]{screenshots/choice_short.eps}

Fig. 3..8: Short Choice

If you have a long list of choices, selecting one of them is done in a different way. Otherwise they might not fit inside the input field.

\includegraphics[scale=1]{screenshots/choice_long.eps}

Fig. 3..9: Long Choice


3.2.9 Grouped Parameters

Parameters that belong together can be grouped.

\includegraphics[scale=1]{screenshots/groups.eps}

Fig. 3..10: Grouped Parameters


Next: 4. Developer Documentation Up: sciparam-manual Previous: 2. Installing SciParam

Thomas Arendsen Hein <thomas@intevation.de>