Location: Renal Transport @ a48c3ecbd9ac / reference-description.html

David Nickerson <nickerso@users.sourceforge.net>
2015-07-29 15:53:01+12:00
adding the begginings of a reStructuredText version of the documentation for this workspace. Describing the reboot of the purpose of this workspace.
Permanent Source URI:

Loading reference description ...
Header Pane
Task Pane
Content Pane
Version: pre-release version 0.1
Author: David Nickerson, Division of Bioengineering, National University of Singapore.


The main window consists of four primary panels. The title pane is the primary title of this reference description as well as the author and date of creation. Clicking the title pane will display the primary top-level documentation of the reference description. The left panel has a tree view of the tasks and graphs contained in this reference description, while the footer has some information on how the reference description was created. The centre panel is the primary display for the contents of the reference description. In this panel each object in the reference description will be displayed in response to user events - either choosing items from the tree on the left or following links from one item to another.

Each content item displayed in the centre panel can be closed by clicking the close button () in the top right corner of the content item's frame. If available, the corresponding XML source for the item can be viewed by clicking the view source icon () also in the top right corner. Within displayed content items, some of the content is presented in summary form with the full description available upon user request. Look for things that have a '+' next to them and try clicking them to display the full description. Clicking the title again will hide the full description once more.

Object types

This reference description consits of various types of objects (content items). The types of objects are:

  • — the top-level task for this reference description;
  • task, which may contain links to child tasks or graphs;
  • graph, the description of a graph defined using CellML graphing metadata;
  • simulation, the description of a simulation (the instantiation of a mathematical model into a numerical experiment) defined using CellML simulation metadata;
  • model, the top level container of a mathematical model defined using CellML. A model acts as a container for annotations of groups of math containers;
  • math container, a container for mathematical equations and variable declarations (equivalent to a CellML component);
  • variable, the basic building block for the mathematical model;
  • — congratulations, you have found something that this code doesn't know about!