1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
|
<html>
<head>
<title>Cain XML File Format</title>
</head>
<body>
<h1>Cain XML File Format</h1>
<p>
Cain files store the models, methods, simulation output, and random number
states. Below is the overall structure of a Cain file. The required elements
are shown in black; the optional elements are colored grey.
</p>
<pre> <?xml version="1.0" encoding="utf-8"?>
<cain version="Number"><font color="#777777">
<listOfModels>
<em>One or more</em> <model> <em>elements.</em>
</listOfModels>
<listOfMethods>
<em>One or more</em> <method> <em>elements.</em>
</listOfMethods>
<listOfOutput>
<em>One or more output elements.</em>
</listOfOutput>
<random>
<em>Zero or more</em> <stateMT19937> <em>elements.</em>
</random></font>
</cain></pre>
<p>
In the next few sections we will describe each of the top-level elements.
Each element attribute has one of the following formats:
<ul>
<li> An <b>Identifier</b> is a string that starts with an underscore
or a letter and is composed entirely of underscores, letters and digits.
See the <a href="UserSpecies.htm">Species Editor</a> section for details.
<li> A <b>String</b> is an arbitrary string (sequence of characters). These
are used for descriptive names.
<li> <b>Boolean</b> is either "true" or "false".
<li> <b>Integer</b> is a 32-bit unsigned integer.
<li> <b>Number</b> is a floating-point number.
<li> <b>PythonExpression</b> is a Python expression. If you use functions
from the math package, don't use the "math." qualification,
i.e. write "floor(exp(5))" instead of
"math.floor(math.exp(5))".
See the discussion of initial amounts in the
<a href="UserSpecies.htm">Species Editor</a> section for more information.
<li> <b>C++Expression</b> is a C++ expression.
See the <a href="UserReactions.htm">Reaction Editor</a> section for details.
</ul>
</p>
</body>
</html>
|