Difference between revisions of "Config:ContextConfig"

From SUMOwiki
Jump to navigationJump to search
m
Line 1: Line 1:
 +
'''Generated for SUMO toolbox version 6'''.
 +
''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.''
 
== ContextConfig ==
 
== ContextConfig ==
 
=== OutputDirectory ===
 
=== OutputDirectory ===
TODO OutputDirectory DOC
+
Specifies the directory to use (relative to the project directory to store the results, logs, ...
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
  
<!--TODO OutputDirectory DOC-->
+
<!--Specifies the directory to use (relative to the project directory to store the results, logs, ...-->
 
<[[Config:OutputDirectory|OutputDirectory]]>output</[[Config:OutputDirectory|OutputDirectory]]></source>
 
<[[Config:OutputDirectory|OutputDirectory]]>output</[[Config:OutputDirectory|OutputDirectory]]></source>
=== Custom Options ===
 
Available options:
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
 
 
<!--save model to disk as Matlab .mat file-->
 
<Option key="saveModels" value="true"/></source>
 
 
=== PlotOptions ===
 
=== PlotOptions ===
TODO PlotOptions DOC
+
Several options for configuring the intermediate plots can be found here
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
  
<!--TODO PlotOptions DOC-->
+
<!--Several options for configuring the intermediate plots can be found here-->
 
<[[Config:PlotOptions|PlotOptions]]>
 
<[[Config:PlotOptions|PlotOptions]]>
  
   <!-- do any plot at all ? -->
+
   <!-- save model to disk as Matlab .mat file -->
 +
  <Option key="saveModels" value="true"/>
 +
 
 +
  <!-- plot models model plots to disk -->
 
   <Option key="plotModels" value="true"/>
 
   <Option key="plotModels" value="true"/>
  
Line 29: Line 28:
  
 
   <!--
 
   <!--
 +
      Other options:
 
   <Option key="plotPoints" value="true"/>
 
   <Option key="plotPoints" value="true"/>
 
   <Option key="lighting" value="false"/>
 
   <Option key="lighting" value="false"/>
Line 38: Line 38:
 
   -->
 
   -->
  
  <!-- Save all plots to disk -->
 
  <Option key="saveModelPlots" value="true"/>
 
 
   <!-- 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 ===
 
=== Path ===
Line 73: Line 76:
 
   To select all profilers, simply put ".*"
 
   To select all profilers, simply put ".*"
 
   -->
 
   -->
   <[[Config:Profiler|Profiler]] name=".*Measure.*|.*BestModel.*|.*ElapsedTime.*|.*Resources.*" enabled="true">
+
   <[[Config:Profiler|Profiler]] name=".*Minimum.*|.*Measure.*|.*BestModel.*|.*ElapsedTime.*|.*MemoryUse.*" enabled="true">
 
       <[[Config:Output|Output]] type="[[Output#Docked|Docked]]"/>
 
       <[[Config:Output|Output]] type="[[Output#Docked|Docked]]"/>
 
       <[[Config:Output|Output]] type="[[Output#toImage|toImage]]"/>
 
       <[[Config:Output|Output]] type="[[Output#toImage|toImage]]"/>

Revision as of 14:26, 17 July 2008

Generated for SUMO toolbox version 6. 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.

ContextConfig

OutputDirectory

Specifies the directory to use (relative to the project directory to store the results, logs, ...

<!--Specifies the directory to use (relative to the project directory to store the results, logs, ...-->
<[[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"/>
   <!-- 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]]>

Path

Empty by default, but a user can add directories to the path as he wishes.

<!--Empty by default, but a user can add directories to the path as he wishes.-->
<[[Config:Path|Path]]>
   <!--AddPath recurse="true">/home/myPath</[[Config:AddPath|AddPath]]-->
</[[Config:Path|Path]]>

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]]>
   <!-- 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
   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=".*Minimum.*|.*Measure.*|.*BestModel.*|.*ElapsedTime.*|.*MemoryUse.*" enabled="true">
      <[[Config:Output|Output]] type="[[Output#Docked|Docked]]"/>
      <[[Config:Output|Output]] type="[[Output#toImage|toImage]]"/>
      <[[Config:Output|Output]] type="[[Output#toFile|toFile]]"/>
   </[[Config:Profiler|Profiler]]>
            
</[[Config:Profiling|Profiling]]>