Uncategorized WMT developer notes: Difference between revisions

From CSDMS
Created page with "==Uncategorized WMT developer notes== ===The '''wmt.yaml''' file=== This file describes how the parameters listed model developer in the '''parameters.yaml''' file are repre..."
 
m Words
 
Line 3: Line 3:
===The '''wmt.yaml''' file===
===The '''wmt.yaml''' file===


This file describes how the parameters listed model developer in the '''parameters.yaml''' file
This file describes how the parameters listed by the model developer in the '''parameters.yaml''' file
are represented and displayed in the WMT client.
are represented and displayed in the WMT client.
There need not be a one-to-one correspondence between the files.
There need not be a one-to-one correspondence between the files.
Additional, private, parameters can be defined in '''wmt.yaml''' to augment how the model's parameters are displayed.
Additional, private, parameters (typically prefixed with an underscore)
can be defined in '''wmt.yaml''' to augment how the model's parameters are displayed.
Using component hooks,
Using component hooks,
these private parameters can be translated into a form for the model's parameters.
these private parameters can be translated into a form for the model's parameters.

Latest revision as of 15:07, 14 November 2017

Uncategorized WMT developer notes

The wmt.yaml file

This file describes how the parameters listed by the model developer in the parameters.yaml file are represented and displayed in the WMT client. There need not be a one-to-one correspondence between the files. Additional, private, parameters (typically prefixed with an underscore) can be defined in wmt.yaml to augment how the model's parameters are displayed. Using component hooks, these private parameters can be translated into a form for the model's parameters.

The run/visualize API call

Add a parameter, _visualization, to wmt.yaml with the path to a file in a model's output to display in a browser window from the WMT client. If this parameter isn't present, a directory listing for the component is displayed instead.

This only works for the driver. This could be changed.