Difference between revisions of "Config:ContextConfig"

From SUMOwiki
Jump to navigationJump to search
Line 1: Line 1:
'''Generated for SUMO toolbox version 6'''.
+
'''Generated for SUMO toolbox version 6.1'''.
''We are well aware that the list below is incomplete and possibly even out of date in some cases. We try to document everything as best we can but much is limited by available time and manpower.  The most up to date documentation can always be found (if not here) in the default.xml configuration file and, of course, in the source files.''
+
''We are well aware that documentation is not always complete and possibly even out of date in some cases. We try to document everything as best we can but much is limited by available time and manpower.  We are an university research group after all. The most up to date documentation can always be found (if not here) in the default.xml configuration file and, of course, in the source files.  If something is unclear please dont hesitate to [[Reporting problems|ask]].''
 
== ContextConfig ==
 
== ContextConfig ==
 
=== OutputDirectory ===
 
=== OutputDirectory ===
Specifies the directory to use (relative to the project directory to store the results, logs, ...
+
Specifies the directory to use to store the results, logs, ... An absolute path can be specified, if not it is relative to the project directory.
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
  
<!--Specifies the directory to use (relative to the project directory to store the results, logs, ...-->
+
<!--Specifies the directory to use to store the results, logs, ... An absolute path can be specified, if not it is relative to the project directory.-->
 
<[[Config:OutputDirectory|OutputDirectory]]>output</[[Config:OutputDirectory|OutputDirectory]]></source>
 
<[[Config:OutputDirectory|OutputDirectory]]>output</[[Config:OutputDirectory|OutputDirectory]]></source>
 
=== PlotOptions ===
 
=== PlotOptions ===
Line 40: Line 40:
 
   <!-- Output file format of the plot: png (default),eps,bmp,jpg,... -->
 
   <!-- Output file format of the plot: png (default),eps,bmp,jpg,... -->
 
   <Option key="outputType" value="png"/>
 
   <Option key="outputType" value="png"/>
  <!-- Keep models from previous model iterations.
 
        See:
 
        http://www.sumowiki.intec.ugent.be/index.php/FAQ#I_sometimes_see_the_error_of_the_best_model_go_up.2C_shouldn.27t_it_decrease_monotonically.3F
 
  -->
 
  <Option key="keepOldModels" value="off"/>
 
 
</[[Config:PlotOptions|PlotOptions]]></source>
 
</[[Config:PlotOptions|PlotOptions]]></source>
=== Path ===
+
=== Custom Options ===
Empty by default, but a user can add directories to the path as he wishes.
+
Available options:
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
  
<!--Empty by default, but a user can add directories to the path as he wishes.-->
+
<!--Keep models from previous model iterations. See: http://www.sumowiki.intec.ugent.be/index.php/FAQ#I_sometimes_see_the_error_of_the_best_model_go_up.2C_shouldn.27t_it_decrease_monotonically.3F-->
<[[Config:Path|Path]]>
+
<Option key="keepOldModels" value="off"/>
  <!--AddPath recurse="true">/home/myPath</[[Config:AddPath|AddPath]]-->
+
<!--If set to on the parallelMode option will check if the Matlab Parallel Computing Toolbox is installed. If so, model construction will occur in parallel where possible, thus speeding things up. Note that this option is still somewhat experimental. If you get weird problems switch it off again.-->
</[[Config:Path|Path]]></source>
+
<Option key="parallelMode" value="off"/></source>
 
=== Profiling ===
 
=== Profiling ===
 
Configuration options for the profiler: Within a profiler block, one or more &lt;Output type="type"/&gt; specifiers should be present. Possible types are toFile, toPanel, Docked, and toImage. When using the toPanel, Docked, and toImage output specifiers, an extra `chartType' option can be used. See the types present in the Docked view to see which types are available.
 
Configuration options for the profiler: Within a profiler block, one or more &lt;Output type="type"/&gt; specifiers should be present. Possible types are toFile, toPanel, Docked, and toImage. When using the toPanel, Docked, and toImage output specifiers, an extra `chartType' option can be used. See the types present in the Docked view to see which types are available.
Line 60: Line 55:
 
<!--Configuration options for the profiler: Within a profiler block, one or more <[[Config:Output|Output]] type="[[Output#type|type]]"/> specifiers should be present. Possible types are toFile, toPanel, Docked, and toImage. When using the toPanel, Docked, and toImage output specifiers, an extra `chartType' option can be used. See the types present in the Docked view to see which types are available.-->
 
<!--Configuration options for the profiler: Within a profiler block, one or more <[[Config:Output|Output]] type="[[Output#type|type]]"/> specifiers should be present. Possible types are toFile, toPanel, Docked, and toImage. When using the toPanel, Docked, and toImage output specifiers, an extra `chartType' option can be used. See the types present in the Docked view to see which types are available.-->
 
<[[Config:Profiling|Profiling]]>
 
<[[Config:Profiling|Profiling]]>
  <!-- Only enable if you are using levelplots -->
 
  <[[Config:Profiler|Profiler]] name="LevelPlotProfiler.*" enabled="false">
 
      <[[Config:Output|Output]] type="[[Output#Docked|Docked]]">
 
        <Option key="chartType" value="level"/>
 
      </[[Config:Output|Output]]>
 
      <[[Config:Output|Output]] type="[[Output#toImage|toImage]]">
 
        <Option key="chartType" value="level"/>
 
      </[[Config:Output|Output]]>
 
      <[[Config:Output|Output]] type="[[Output#toFile|toFile]]"/>
 
  </[[Config:Profiler|Profiler]]>
 
 
 
   <!--
 
   <!--
 
   You can restrict the available profilers to use by specifying a wildcard
 
   You can restrict the available profilers to use by specifying a wildcard
Line 76: Line 60:
 
   To select all profilers, simply put ".*"
 
   To select all profilers, simply put ".*"
 
   -->
 
   -->
   <[[Config:Profiler|Profiler]] name=".*Minimum.*|.*Measure.*|.*BestModel.*|.*ElapsedTime.*|.*MemoryUse.*" enabled="true">
+
   <[[Config:Profiler|Profiler]] name=".*SampleMinimum.*|.*Measure.*|.*BestModel.*|.*ElapsedTime.*|.*MemoryUse.*" enabled="true">
 
       <[[Config:Output|Output]] type="[[Output#Docked|Docked]]"/>
 
       <[[Config:Output|Output]] type="[[Output#Docked|Docked]]"/>
 +
      <!-- note that the toImage handler is quite expensive to use, removing it will speed things up -->
 
       <[[Config:Output|Output]] type="[[Output#toImage|toImage]]"/>
 
       <[[Config:Output|Output]] type="[[Output#toImage|toImage]]"/>
 
       <[[Config:Output|Output]] type="[[Output#toFile|toFile]]"/>
 
       <[[Config:Output|Output]] type="[[Output#toFile|toFile]]"/>
   </[[Config:Profiler|Profiler]]>
+
   </[[Config:Profiler|Profiler]]>    
           
 
 
</[[Config:Profiling|Profiling]]></source>
 
</[[Config:Profiling|Profiling]]></source>

Revision as of 18:11, 17 February 2009

Generated for SUMO toolbox version 6.1. We are well aware that documentation is not always complete and possibly even out of date in some cases. We try to document everything as best we can but much is limited by available time and manpower. We are an university research group after all. The most up to date documentation can always be found (if not here) in the default.xml configuration file and, of course, in the source files. If something is unclear please dont hesitate to ask.

ContextConfig

OutputDirectory

Specifies the directory to use to store the results, logs, ... An absolute path can be specified, if not it is relative to the project directory.

<!--Specifies the directory to use to store the results, logs, ... An absolute path can be specified, if not it is relative to the project directory.-->
<[[Config:OutputDirectory|OutputDirectory]]>output</[[Config:OutputDirectory|OutputDirectory]]>

PlotOptions

Several options for configuring the intermediate plots can be found here

<!--Several options for configuring the intermediate plots can be found here-->
<[[Config:PlotOptions|PlotOptions]]>

   <!-- save model to disk as Matlab .mat file -->
   <Option key="saveModels" value="true"/>

   <!-- plot models model plots to disk -->
   <Option key="plotModels" value="true"/>

   <!-- contours, only available for 2 dimensions -->
   <!-- plot contours on same plot as model -->
   <Option key="withContour" value="true"/>
   <!-- plot separate contour of model, never saved to disk -->
   <Option key="plotContour" value="false"/>

   <!--
       Other options:
   <Option key="plotPoints" value="true"/>
   <Option key="lighting" value="false"/>
   <Option key="slices" value="3"/>
   <Option key="grayScale" value="false"/>
   <Option key="meshSize" value="41"/>
   <Option key="fontSize" value="14"/>
   <Option key="logScale" value="false"/>
   -->

   <!-- Output file format of the plot: png (default),eps,bmp,jpg,... -->
   <Option key="outputType" value="png"/>
</[[Config:PlotOptions|PlotOptions]]>

Custom Options

Available options:

<!--Keep models from previous model iterations. See: http://www.sumowiki.intec.ugent.be/index.php/FAQ#I_sometimes_see_the_error_of_the_best_model_go_up.2C_shouldn.27t_it_decrease_monotonically.3F-->
<Option key="keepOldModels" value="off"/>
<!--If set to on the parallelMode option will check if the Matlab Parallel Computing Toolbox is installed. If so, model construction will occur in parallel where possible, thus speeding things up. Note that this option is still somewhat experimental. If you get weird problems switch it off again.-->
<Option key="parallelMode" value="off"/>

Profiling

Configuration options for the profiler: Within a profiler block, one or more <Output type="type"/> specifiers should be present. Possible types are toFile, toPanel, Docked, and toImage. When using the toPanel, Docked, and toImage output specifiers, an extra `chartType' option can be used. See the types present in the Docked view to see which types are available.

<!--Configuration options for the profiler: Within a profiler block, one or more <[[Config:Output|Output]] type="[[Output#type|type]]"/> specifiers should be present. Possible types are toFile, toPanel, Docked, and toImage. When using the toPanel, Docked, and toImage output specifiers, an extra `chartType' option can be used. See the types present in the Docked view to see which types are available.-->
<[[Config:Profiling|Profiling]]>
   <!--
   You can restrict the available profilers to use by specifying a wildcard
   to disable the docked output if you dont want a window containing all the profilers.
   To select all profilers, simply put ".*"
   -->
   <[[Config:Profiler|Profiler]] name=".*SampleMinimum.*|.*Measure.*|.*BestModel.*|.*ElapsedTime.*|.*MemoryUse.*" enabled="true">
      <[[Config:Output|Output]] type="[[Output#Docked|Docked]]"/>
      <!-- note that the toImage handler is quite expensive to use, removing it will speed things up -->
      <[[Config:Output|Output]] type="[[Output#toImage|toImage]]"/>
      <[[Config:Output|Output]] type="[[Output#toFile|toFile]]"/>
   </[[Config:Profiler|Profiler]]>      
</[[Config:Profiling|Profiling]]>