Difference between revisions of "Config:ContextConfig"

From SUMOwiki
Jump to navigationJump to search
(AutoConfig for SUMO 6.2)
Line 1: Line 1:
'''Generated for SUMO toolbox version 6.1'''.
+
'''Generated for SUMO toolbox version 6.2'''.
 
''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]].''
 
''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 ==
Line 7: Line 7:
  
 
<!--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]]></source>
+
  <[[Config:OutputDirectory|OutputDirectory]]>output</[[Config:OutputDirectory|OutputDirectory]]></source>
 
=== PlotOptions ===
 
=== PlotOptions ===
 
Several options for configuring the intermediate plots can be found here
 
Several options for configuring the intermediate plots can be found here
Line 13: Line 13:
  
 
<!--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]]>
+
  <[[Config:PlotOptions|PlotOptions]]>
  
  <!-- save model to disk as Matlab .mat file -->
+
      <!-- save model to disk as Matlab .mat file -->
  <Option key="saveModels" value="true"/>
+
      <Option key="saveModels" value="true"/>
  
  <!-- plot models model plots to disk -->
+
      <!-- plot models model plots to disk -->
  <Option key="plotModels" value="true"/>
+
      <Option key="plotModels" value="true"/>
  
  <!-- contours, only available for 2 dimensions -->
+
      <!-- contours are  only available for 2 dimensions -->
  <!-- plot contours on same plot as model -->
+
     
  <Option key="withContour" value="true"/>
+
      <!-- plot contours on same plot as model -->
  <!-- plot separate contour of model, never saved to disk -->
+
      <Option key="withContour" value="true"/>
  <Option key="plotContour" value="false"/>
+
      <!-- plot separate contour of model, never saved to disk -->
 +
      <Option key="plotContour" value="false"/>
 +
      <!-- also plot the model uncertainty, only supported by some models types -->
 +
      <Option key="plotUncertainty" value="false"/>
  
  <!--
+
      <!--
      Other options:
+
      Other options to customize plotting:
  <Option key="plotPoints" value="true"/>
+
     
  <Option key="lighting" value="false"/>
+
      <Option key="plotPoints" value="true"/>
  <Option key="slices" value="3"/>
+
      <Option key="lighting" value="false"/>
  <Option key="grayScale" value="false"/>
+
      <Option key="slices" value="3"/>
  <Option key="meshSize" value="41"/>
+
      <Option key="grayScale" value="false"/>
  <Option key="fontSize" value="14"/>
+
      <Option key="meshSize" value="41"/>
  <Option key="logScale" value="false"/>
+
      <Option key="fontSize" value="14"/>
  -->
+
      <Option key="logScale" value="false"/>
 +
      -->
  
  <!-- 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"/>
</[[Config:PlotOptions|PlotOptions]]></source>
+
  </[[Config:PlotOptions|PlotOptions]]></source>
 
=== Custom Options ===
 
=== Custom Options ===
 
Available options:
 
Available options:
Line 46: Line 50:
  
 
<!--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-->
 
<!--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"/>
+
  <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.-->
 
<!--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"/></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 profilers. Profilers allow you to track the modeling process and understand what happens. Within a profiler block, one or more &lt;Output type="type"/&gt; specifiers should be present. Possible types are toFile, toPanel, toTable, and toImage.
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
  
<!--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 profilers. Profilers allow you to track the modeling process and understand what happens. Within a profiler block, one or more <[[Config:Output|Output]] type="[[Output#type|type]]"/> specifiers should be present. Possible types are toFile, toPanel, toTable, and toImage.-->
<[[Config:Profiling|Profiling]]>
+
  <[[Config:Profiling|Profiling]]>
  <!--
+
      <!--
  You can restrict the available profilers to use by specifying a wildcard
+
      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 disable the docked output if you dont want a window containing all the profilers.
+
      To select all profilers, simply put ".*"
  To select all profilers, simply put ".*"
+
      -->
  -->
+
      <[[Config:Profiler|Profiler]] name=".*SampleMinimum.*|.*Measure.*|.*BestModel.*|.*ElapsedTime.*|.*MemoryUse.*" enabled="true">
  <[[Config:Profiler|Profiler]] name=".*SampleMinimum.*|.*Measure.*|.*BestModel.*|.*ElapsedTime.*|.*MemoryUse.*" enabled="true">
+
        <!-- note that the toImage/toPanel handlers are quite expensive to use, removing them will speed things up -->
      <[[Config:Output|Output]] type="[[Output#Docked|Docked]]"/>
+
        <[[Config:Output|Output]] type="[[Output#toPanel|toPanel]]"/>
      <!-- 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#toTable|toTable]]"/>
      <[[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 12:15, 2 October 2009

Generated for SUMO toolbox version 6.2. 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 are  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"/>
      <!-- also plot the model uncertainty, only supported by some models types -->
      <Option key="plotUncertainty" value="false"/>

      <!--
      Other options to customize plotting:
      
      <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 profilers. Profilers allow you to track the modeling process and understand what happens. Within a profiler block, one or more <Output type="type"/> specifiers should be present. Possible types are toFile, toPanel, toTable, and toImage.

<!--Configuration options for the profilers. Profilers allow you to track the modeling process and understand what happens. Within a profiler block, one or more <[[Config:Output|Output]] type="[[Output#type|type]]"/> specifiers should be present. Possible types are toFile, toPanel, toTable, and toImage.-->
   <[[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">
         <!-- note that the toImage/toPanel handlers are quite expensive to use, removing them will speed things up -->
         <[[Config:Output|Output]] type="[[Output#toPanel|toPanel]]"/>
         <[[Config:Output|Output]] type="[[Output#toImage|toImage]]"/>
         <[[Config:Output|Output]] type="[[Output#toTable|toTable]]"/>
         <[[Config:Output|Output]] type="[[Output#toFile|toFile]]"/>
      </[[Config:Profiler|Profiler]]>      
   </[[Config:Profiling|Profiling]]>