Updated HTML documentation.

TerraME · Jul 17, 2015 · f34a08b · f34a08b
1 parent eea4600
commit f34a08b
Show file tree

Hide file tree

Showing 2 changed files with 74 additions and 2 deletions.
diff --git a/doc/files/SysDynModel.html b/doc/files/SysDynModel.html
@@ -184,6 +184,7 @@ <h1><code>SysDynModel
 <span class="description">Template for Systems Dynamics Model.</span>
 
 
+
 
 
 <!-- Function arguments -->
@@ -196,9 +197,71 @@ <h3>Arguments</h3>
 
 
     <li>
-	  <strong>graphics</strong>: A table with internal tables describing how the parameters of the model will be drawn in the screen. It can have three values: 
+	  <strong>graphics</strong>: A table with internal tables describing how the parameters of the model will be drawn in the screen. It can have three values:
     </li> 
 
+      </span>
+      <!-- Strategy of the argument -->
+
+      <table class="arg_tab">
+
+
+        <tr>
+
+
+            <th>
+            Graphics
+            </th>
+
+
+            <th>
+            Description
+            </th>
+
+
+        <tr>
+
+
+            <td>
+            "timeseries"
+            </td>
+
+
+            <td>
+            A table with internal tables describing sets of attributes to be drawn with time as x axis.
+            </td>
+
+
+        <tr>
+
+
+            <td>
+            "cobweb"
+            </td>
+
+
+            <td>
+            Draw a cobweb plot. Not implemented yet.
+            </td>
+
+
+        <tr>
+
+
+            <td>
+            "phasespace"
+            </td>
+
+
+            <td>
+            A table with internal tables with the attributes to be drawn as a phase space. The first attribute of every internal table will be used as x axis.
+            </td>
+
+
+        </tr>    
+      </table>
+      <span class="arg">
+
 
     <li>
 	  <strong>...</strong>: Any other value that can be used as parameter for the Model.
@@ -218,7 +281,10 @@ <h3>Usage</h3>
     <span class="id">water</span> = <span class="number">20</span>,
     <span class="id">changes</span> = <span class="reserved">function</span>(<span class="id">model</span>)
         <span class="id">model</span>.<span class="id">water</span> = <span class="id">model</span>.<span class="id">water</span> - <span class="number">1</span>
-    <span class="reserved">end</span>
+    <span class="reserved">end</span>,
+    <span class="id">graphics</span> = {
+        <span class="id">timeseries</span> = {{<span class="string">"water"</span>}},
+    }
 }</code></pre>
 
 

diff --git a/doc/files/models.html b/doc/files/models.html
@@ -274,6 +274,12 @@ <h3>Arguments</h3>
 
 									    <li><strong>finalTime</strong>: The final time of the simulation. The minimum value is 50 and the default value is 500.</li> 
 
+									    <li><strong>predDeath</strong>: A number between 0.001 and 0.5 with the probability of a predator to die. The default value is 0.02.</li> 
+
+									    <li><strong>predGrowthKills</strong>: A number between 0 and 0.01 with the increase in the size of the predator population per eack prey killed. The default value is 0.00002.</li> 
+
+									    <li><strong>preyDeathPred</strong>: A number between 0.0001 and 0.01 with the probability of a prey to be killed by a predator. The default value is 0.001.</li> 
+
 									    <li><strong>preyGrowth</strong>: A number between 0.01 and 1 with the probability of a prey to reproduce. The default value is 0.08.</li> 
 
 									    <li><strong>rabbits</strong>: A number between 100 and 1000 with the initial number of rabbits.</li>