Introduction to JSim RTML


JSim Run-Time Markup Language (RTML) is an XML dialect that specifies the run-time appearance of a compiled model in terms of pages and menus. There are two RTML documents associated with any JSim model: the default RTML and the custom RTML. The default RTML is generated internally and produces the familiar "Inputs", "Outputs", "Solvers" and "Function generator" pages in a model's "Run time" tab. The optional custom RTML may be created by a model writer to improve the JSim user's run-time experience by providing a nested set of pages, tables, diagrams and menus that make the model easier to navigate and understand. This document provides a starting point for adding RTML to a JSim model. 



Getting Started

Most RTML writers will find it useful to look at some examples before seriously examining at the RTML specification. You may view the default RTML for a model via the "Export default RTML..." item in the "Pages" menu of a model's "Run Time" tab (the model must be compiled to do this). More complex examples of custom RTML may found in the project files distributed with the JSim Fortran Package (fpack) . For such models, the "Export custom RTML..." item in the "Pages" menu above will allow you to view the custom RTML.

Custom RTML, created is accordance with the RTML Reference Manual , may be associated with a JSim model via the "Import custom RTML..." item in the "Pages" menu above.

Alternatively, jsbatch users may use the "-rtml" switch. In the following example, the custom RTML "spiffy.rtml" is loaded into the model "axon" within old.proj, and saved in new.proj:

      jsbatch -f old.proj -rtml axon:spiffy.rtml -oproj > new.proj

Model Images

Custom RTML often uses image elements to provide graphic images within pages. image elements contain the name of the image rather than the actual image data. Image data is stored in a model's image set, which may be viewed and edited within a model's "Images" tab. Each image must be assigned a name by which it is known in RTML. That name may not contain spaces or punctuation. Image formats GIF, JPEG and PNG are currently supported. Other formats may be available in the future. The JSim GUI supports standard import/export/rename/delete functions for images within the image set.

Alternatively, jsbatch users may load images into a project file via the -img switch. In the following example, the image leg.gif are loaded into the example1 axon model with name Leg:

      jsbatch -f old.proj -img axon.images.Leg:leg.gif -oproj > new.proj

The -rtml and multiple -img switches may be used to load externally generated custom RTML and associated images with a single jsbatch command.

Comments or Questions?

Give feedback


Model development and archiving support at provided by the following grants: NIH U01HL122199 Analyzing the Cardiac Power Grid, 09/15/2015 - 05/31/2020, NIH/NIBIB BE08407 Software Integration, JSim and SBW 6/1/09-5/31/13; NIH/NHLBI T15 HL88516-01 Modeling for Heart, Lung and Blood: From Cell to Organ, 4/1/07-3/31/11; NSF BES-0506477 Adaptive Multi-Scale Model Simulation, 8/15/05-7/31/08; NIH/NHLBI R01 HL073598 Core 3: 3D Imaging and Computer Modeling of the Respiratory Tract, 9/1/04-8/31/09; as well as prior support from NIH/NCRR P41 RR01243 Simulation Resource in Circulatory Mass Transport and Exchange, 12/1/1980-11/30/01 and NIH/NIBIB R01 EB001973 JSim: A Simulation Analysis Platform, 3/1/02-2/28/07.