Difference between revisions of "Adding an example"

From SUMOwiki
Line 8: Line 8:
 
** scattered data (<ScatteredDataFile> tag)
 
** scattered data (<ScatteredDataFile> tag)
 
** gridded data, data lies on a regular grid (<GriddedDataFile>)
 
** gridded data, data lies on a regular grid (<GriddedDataFile>)
  +
  +
Datasets should be placed in <code>examples/data/txt</code>.
 
In case of doubt about which dataset to use, use 'ScatteredDataFile'.
 
In case of doubt about which dataset to use, use 'ScatteredDataFile'.
   
Datasets should be placed in <code>examples/data/txt</code>. Matlab scripts should be placed in <code>src/matlab/examples</code>.
+
Matlab scripts should be placed in <code>src/matlab/examples</code>.
   
 
For an explanation of the data format and how the toolbox interfaces with the [[simulator]], see the [[Interfacing with the toolbox]] page.
 
For an explanation of the data format and how the toolbox interfaces with the [[simulator]], see the [[Interfacing with the toolbox]] page.

Revision as of 18:03, 10 June 2008

If you want to create a surrogate model (metamodel) for your own problem you will first have to write a simulator xml file. To do this simply open one of the existing simulator xml files (in the examples/ subdirectory) and create a copy of it in the same directory but under a new name. You can then edit this file to suit your particular problem. This file should be pretty straightforward to write.

Your simulator XML file may specify different implementations:

  • an executable or script (<Executable> tag)
  • a Java class (<Executable> tag, platform = java)
  • a Matlab script (<Executable> tag, platform = matlab)
  • a dataset
    • scattered data (<ScatteredDataFile> tag)
    • gridded data, data lies on a regular grid (<GriddedDataFile>)

Datasets should be placed in examples/data/txt. In case of doubt about which dataset to use, use 'ScatteredDataFile'.

Matlab scripts should be placed in src/matlab/examples.

For an explanation of the data format and how the toolbox interfaces with the simulator, see the Interfacing with the toolbox page.

Having written your simulator XML file and provided the datasets/executables you now just need to change default.xml so it uses your file (<Simulator> tag). Finally you just run 'go'.

Note that, depending on whether your simulator is a script, native executable, dataset or Matlab script you will need to set different sample evaluator configuration options. For example, if your data comes from a dataset you will have to set the sample evaluator to scattered or gridded, depending if you data points are scattered or on a regular grid. If on the other hand your data comes from a native executable you would want to use the local sample evaluator with the simulatorType set to "external" (you can also set the type to "java" if your executable is a java class). For Matlab scripts the sample evaluator to use is matlab.