"Seegrid will be due for a migration to confluence on the 1st of August. Any update on or after the 1st of August will NOT be migrated"

Adding content

The Scientific Solutions Centre includes a basic admin interface for adding entries to the catalogue. It can be found under the Admin menu in the navbar, where there are links to the management and new entry pages for problems, solutions and toolboxes. The development version is available at http://vhirl-dev.csiro.au/scm/admin/.

Admin menu

Selecting one of the Manage entries, or clicking on an entry type in the nav bar of the admin screen will show a list of summaries of entries of that type, similar to the following. Click on the ssc_pencil.pngicon to edit an entry in the list, or click on the Create tab above the list to create a new entry of the appropriate type.

List of entries

There are some fields that are common to all entries in the catalogue (Name, Description, Created At, Author, Version), so every new entry form will include those fields, as in the example below. The content of the description field is interpreted as markdown, and so can includes links and basic formatting. See some of the existing entries for examples.

ssc_common.png

Problem

A problem is currently simply a name and a description, so only the common fields are available, as in the image above. If a solution solves a new problem, the new problem should be added first so that a new solution can be linked to it.

Solution

A solution describes a script template that executes the workflow to solve a problem. As well as filling in the name/description, a solution requires a link to the problem that it solves and the toolbox that it depends on. The available problems and toolboxes are presented as drop downs for the Problem and Toolbox fields.

ssc_solution1.png

Template

The Template field should contain the python script that will be executed. It's easiest to copy the script text from an editor into the Template text area so that it retains the appropriate python formatting.

The python code should contain placeholders for variable values. These are used by the execution environment to set, or allow the user running the job to set, values that are used by the code. The placeholders consist of a variable name wrapped in ${}. The whole placeholder string, including delimiters, will be replaced with the string value of the corresponding variable. It is a simple text replacement, so variables can be used anywhere in the template script, including in comments. Below is an example from the "ANUGA Busselton example" entry showing placeholders for variables named input_dataset and name_stem. See the next section for details about describing the variables themselves.
# Filename for input data (NetCDF format)
dataset = '${input_dataset}'
name_stem = scenario_name = '${name_stem}'
meshname = name_stem + '.msh'

Variables

Each variable in the template should have a corresponding entry in the solution. Click on the Add Var button at the end of the form to add a new variable. You must include at least a name and type for each variable, and the name must be the same string used in the corresponding placeholder in the template. The variable type is limited to the entries in the Type dropdown, and is used to provide a sensible UI for the user to set the variable value at runtime. The label and description are user-friendly descriptive text for use in user interfaces.

Default can be used to set a default value for the variable. Numeric types can have Min/Max/Step values set, which will be used to enforce minimum, maximum and intermediate values for the variable if they are set. Note that setting Step only makes sense if Min and Max are also set.

Values can be used to provide a limited set of valid values for a variable of any non-random type. It should be entered as a json string that encodes an array of values. For example, in the image below the variable's value has been limited to one of the strings 'a', 'b' or 'c'.

ssc_solution_var.png

Toolbox

Add a toolbox.

-- GeoffreySquire - 01 Dec 2014
Topic attachments
I Attachment Action Size Date Who Comment
ssc_admin_menu.pngpng ssc_admin_menu.png manage 78.0 K 01 Dec 2014 - 12:43 GeoffreySquire  
ssc_common.pngpng ssc_common.png manage 19.6 K 01 Dec 2014 - 12:53 GeoffreySquire  
ssc_list.pngpng ssc_list.png manage 80.0 K 01 Dec 2014 - 12:43 GeoffreySquire  
ssc_pencil.pngpng ssc_pencil.png manage 0.3 K 01 Dec 2014 - 12:48 GeoffreySquire  
ssc_solution1.pngpng ssc_solution1.png manage 36.7 K 01 Dec 2014 - 12:59 GeoffreySquire  
ssc_solution_var.pngpng ssc_solution_var.png manage 5.2 K 01 Dec 2014 - 13:39 GeoffreySquire  
Topic revision: r2 - 13 Feb 2015, RyanFraser
 

Current license: All material on this collaboration platform is licensed under a Creative Commons Attribution 3.0 Australia Licence (CC BY 3.0).