Detailed output files

In this document:
What is a detailed output file?
Contents of a detailed output file
Viewing the data in a detailed output file
Detailed output files as input to other runs

For more on output, including a guide on what to save, see the topic Output in SORTIE.

What is a detailed output file?

The model saves its detailed output in a detailed output file. A simulation's detailed output file is in fact a collection of individual files packaged together. Within the detailed output package are two types of files: a copy of the parameter file originally used to perform the run, and individual timestep files, which hold the saved data for each timestep. All the files are written in plain text in the XML data format.

Contents of a detailed output file

Detailed output timestep files are collections of map files that you set up using the Edit->Output setup window. They are identified by having "_x" added to the filename, where "x" is the timestep number. The parameter file copy is given the detailed output package's filename. Each file produced is then compressed using the GZIP program, and all the files for a single run are put into an archive file using the TAR program. The detailed output output for a single run is one file with a ".gz.tar" extension.

For example: if the parameter file "testpar.xml" was used to run 5 timesteps, with a detailed output file to be saved named "my detailed output", at the end of the run there would be a file named "my detailed output.gz.tar". This TAR archive would contain the following files:

The ".gz" extension indicates that these files are compressed. If uncompressed, the ".gz" extension would be replaced with ".xml".

Detailed output files are very flexible and can contain any subset of the model's underlying tree and grid data. You pick each individual piece of data that you wish to save, and the frequency with which you wish to save it. The data can be saved at any interval from every timestep to only at the first and last timesteps, and each piece of data has its own save frequency. You can use this to cut down on detailed output file size. Data you are less interested in can be saved less frequently.

Viewing the data in a detailed output file

The Data visualization capabilities of the model interface allow you to see your data graphically. If you want the data raw to do your own analysis, you can save the contents of individual maps within the detailed output files as tab-delimited text. Using the example above, here's how you would use a spreadsheet to read map data from timestep three of the "my detailed output.gz.tar" detailed output file:

  1. To give context to the map data, you must load the original parameter file using File->Open file. Form the run above, either "testpar.xml" could be used, or its copy in the detailed output file, "my detailed output.xml". If you choose the file "my detailed output.gz.tar" from "File->Open file", you can choose the file "my detailed output.xml" within it.
  2. Load the individual timestep file using File->Open file and choosing "my detailed output.gz.tar". You will be able to choose the individual timestep file within it.
  3. Use the Grid layer setup option or the Tree setup in the Edit menu to save the files as tab-delimited text. You can then open it from your spreadsheet application or a text editor.

Detailed output files as input to other runs

The maps in a detailed output timestep file can be used as initial conditions on a subsequent run, provided that they are compatible with the parameter file being used. Here are the requirements for a detailed output map file to be loaded with a parameter file different from its original file:

The detailed output file can be used to completely save the state of the model. If your detailed output file saves everything, you could start a new analysis using any timestep of a previous analysis as the starting point. In order to save a complete detailed output file, use the "Save Everything" button on the Setup detailed output file window.

To load a detailed output file as initial conditions, first decompress the detailed output timestep file into plain text and load the parameter and the detailed output timestep files, as described above. If you don't want to use all the maps, you can erase those for individual grids and trees using the Edit menu options Grid layer setup and Tree setup.

25-Jan-2005 11:37 AM